Contributor's guide and getting started section content #11
Conversation
Signed-off-by: Rupesh <[email protected]>
Signed-off-by: Rupesh <[email protected]>
Signed-off-by: Rupesh <[email protected]>
There was a problem hiding this comment.
Hey @rgrupesh , I went through your documentation and made some suggestions. Please go through them.
|
|
||
| Clone your fork to your local machine:: | ||
|
|
||
| git clone [email protected]:USERNAME/FORKED-PROJECT.git |
There was a problem hiding this comment.
Maybe make this specific to the project, remove FORKED-PROJECT
git clone [email protected]:YourLogin/polyphy.git
[email protected]:YourLogin//PolyPhy-Website.git
|
|
||
| Create a new branch named newfeature or its own simple informative name:: | ||
|
|
||
| git branch newfeature |
There was a problem hiding this comment.
Change to git branch -b newfeature
|
|
||
| git branch -va | ||
|
|
||
| Checkout your master branch and merge upstream:: |
There was a problem hiding this comment.
You've been usingmasterthrough the whole documentation but we are using main
|
|
||
| 1. Make sure all unit tests are successful. | ||
|
|
||
| 2. Tag the current commit on the main branch with a release tag, e.g., ``v1.2.3``. |
There was a problem hiding this comment.
We can use bumpversion package and it will automatically bump the version numbers. Currently, we are looking at 2 places where the version will change
[bumpversion:file:src/polyphy/_version.py]
[bumpversion:file:setup.py]
https://github.com/PolyPhyHub/PolyPhy/blob/main/.bumpversion.cfg
| 5. Run ``tox -e build`` and check that the files in ``dist`` have the correct version (no ``.dirty`` or ``git hash``) according to the git tag. | ||
| Also check the sizes of the distributions, if they are too big (e.g., ``> 500KB``), unwanted clutter may have been accidentally included. | ||
|
|
||
| 6. Run ``tox -e publish -- --repository pypi`` and check that everything were uploaded to `PyPI <https://pypi.org/>`_ correctly. |
There was a problem hiding this comment.
We need to first publish on testpypi and then pypi
| Testing | ||
| ######## | ||
|
|
||
| Running tests locally |
There was a problem hiding this comment.
The documentation can be copied from here https://polyphy.readthedocs.io/en/latest/developer.html#running-tests-locally
| Type "help", "copyright", "credits" or "license" for more information. | ||
| >>> import polyphy | ||
| [Taichi] version 1.0.3, llvm 10.0.0, commit fae94a21, osx, python 3.8.9 | ||
| >>> polyphy.lib.run_2D() |
There was a problem hiding this comment.
polyphy.run3d("run3d")or polyphy.run2d("run2d")
|
@rgrupesh @AsavariA @OskarElek It would be nice if we could have these tests pass so that we can merge this. Also could you point me to the URL for the website? Is there a way to run this locally? |
|
Kudos, SonarCloud Quality Gate passed!
|
Sub tasks: