Skip to content

Commit a6fd045

Browse files
update contribution docs
1 parent ea128b1 commit a6fd045

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/source/contribution.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,24 @@ The following git workflow is recommended for contribution by PR:
4545
4646
pip install -r requirements/requirements.txt
4747
pip install -r requirements/requirements-dev.txt
48+
pip install -r requirements/requirements-types.txt
49+
pip install -r requirements/requirements-extra.txt
4850
4951
Extra packages may be required for specific development tasks.
5052

5153
* Pip installing your fork from the source. This allows you to modify the code locally and immediately test it out.
5254

5355
.. code-block:: bash
5456
55-
python setup.py develop
57+
pip install -e .
5658
5759
* Create a feature branch where you can make modifications and developments. DON'T open PR from your master/main branch.
5860

5961
.. code-block:: bash
6062
6163
git checkout -b <name-of-change>
6264
63-
* Make sure your changes can pass all checks by running: ``./check_all.sh``. (See the :ref:`Checks` section below for details)
65+
* Make sure your changes can pass all checks by running: ``bash check_all.sh``. (See the :ref:`Checks` section below for details)
6466

6567
* Once you are satisfied with your changes, create a commit as follows:
6668

@@ -102,7 +104,7 @@ The scripts include the following components:
102104

103105
* black
104106

105-
* mypy: configure file is ``mypy.ini``, results strongly correlated with the version of numpy, we fix ``numpy==1.21.5`` as mypy standard in CI.
107+
* mypy: configure file is now in ``pyproject.toml``, results strongly correlated with the version of numpy, we fix ``numpy==1.21.5`` as mypy standard in CI.
106108

107109
* pylint: configure file is ``.pylintrc``
108110

@@ -246,7 +248,7 @@ And from GitHub page choose draft a release from tag.
246248

247249
.. code-block:: bash
248250
249-
python setup.py sdist bdist_wheel
251+
python -m build
250252
export VERSION=0.x.y
251253
twine upload dist/tensorcircuit-${VERSION}-py3-none-any.whl dist/tensorcircuit-${VERSION}.tar.gz
252254

0 commit comments

Comments
 (0)