Skip to content

Commit

Permalink
Fix docs (#614)
Browse files Browse the repository at this point in the history
* make the contribution language more friendly

* remove "experimental"
  • Loading branch information
nwlandry authored Oct 29, 2024
1 parent 98a46e9 commit b74205a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
21 changes: 11 additions & 10 deletions HOW_TO_CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,25 @@ Please note we have a [code of conduct](/CODE_OF_CONDUCT.md), please follow it i
2. Add unit tests for features being added or bugs being fixed.
3. 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
5. [OPTIONAL] Format codebase according to the steps below.
5. Submit Pull Request with a list of changes, links to issues that it addresses (if applicable)
6. 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.

## Format codebase
1. 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
2. Remove these unnecessary imports.
3. 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.
4. Format the source code and notebooks by running `black .` for consistent styling.

## 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/release.txt) 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 [\_\_init\_\_.py](xgi/__init__.py.py) to the new version agreed upon by the core developers. The versioning scheme we use is [SemVer](http://semver.org/).
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 -m build` from the main folder. This will create a zipped file to upload to PyPI and save it to the "dist" folder.
6. Using `twine` (a dependency in the [release](requirements/release.txt) requirements file), run `twine upload dist/xgi-[version number].tar.gz`. Enter your username and password.
4. The new version is now on PyPI.
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". This will trigger a GitHub action that will publish the new version on PyPI.
6. The new version is now on PyPI.
2 changes: 0 additions & 2 deletions docs/source/api/core/xgi.core.dihypergraph.DiHypergraph.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

.. currentmodule:: xgi.core.dihypergraph

.. warning::
This is an experimental module. It is not yet stable and may change in the future.
.. autoclass:: DiHypergraph
:show-inheritance:
:members:
Expand Down

0 comments on commit b74205a

Please sign in to comment.