Skip to content

Latest commit

 

History

History
36 lines (29 loc) · 2.95 KB

HOW_TO_CONTRIBUTE.md

File metadata and controls

36 lines (29 loc) · 2.95 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue. Feature additions, bug fixes, etc. should all be addressed with a pull request (PR).

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request process

  1. Download the dependencies in the developer requirements file.
  2. [Optional, but STRONGLY preferred] Add unit tests for features being added or bugs being fixed.
  3. [Optional, but STRONGLY preferred] Include any new method/function in the corresponding docs file.
  4. Run pytest to verify all unit tests pass.
  5. Identify the unnecessary imports in the
    1. source code by running pylint xgi/ --disable all --enable W0611
    2. notebooks by running nbqa pylint . --disable all --enable W0611
  6. Remove these unnecessary imports.
  7. Sort the import statements in the
    1. source code by running isort .
    2. notebooks by running nbqa isort . to sort any new import statements in the source code and tutorials.
  8. Format the source code and notebooks by running black . for consistent styling.
  9. Submit Pull Request with a list of changes, links to issues that it addresses (if applicable)
  10. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

New Version process

  1. Make sure that the Github Actions workflow runs without any errors.
  2. Using the github-changelog package (a dependency in the release requirements file), run changelog -m xgi-org xgi [last release tag] to get the merged pull requests with their links. Paste this into the changelog file under a new heading and edit to make more legible. Associate a GitHub username with each pull request.
  3. Increase the version number in setup.py and conf.py to the new version agreed upon by the core developers. The versioning scheme we use is SemVer.
  4. Commit these changes.
  5. Create a new release on GitHub by selecting "Releases", then clicking "Draft a new release". Click "Choose a tag" and type "v" followed by the version number and then click "Create new tag". The release title will be this same string. Paste the contents of the CHANGELOG into the "Describe this release" field. Click "Publish release".
  6. Run python setup.py sdist from the main folder. This will create a zipped file to upload to PyPI and save it to the "dist" folder.
  7. Using twine (a dependency in the release requirements file), run twine upload dist/xgi-[version number].tar.gz. Enter your username and password.
  8. The new version is now on PyPI.

Attribution

This Contributing Statement is adapted from this template by @PurpleBooth.