Contributor documentation¶
This is guide explains the various tools and steps used to contribute code to Nashpy.
- Tutorial: make a contribution to the documentation
- How to
- How to fork the repository
- How to clone the repository
- How to update from upstream
- How to create a branch
- How to create a virtual environment
- How to install the library from source
- How to run tests
- How to check for insensitive language
- How to write a docstring
- How to write tests
- How to make a commit
- How to push changes
- How to open a pull request
- Discussion
- The code structure of Nashpy
- Writing clean tests with pytest
- Testing across environments with tox
- Installing and packaging with flit
- Virtual environments
- Checking code is tested with coverage
- Testing with properties with hypothesis
- Ensuring consistent code style with Black
- Static code analysis with flake8
- Checking the presence of docstrings with interrogate
- Checking the format of docstrings with darglint
- Using sphinx for documentation
- Ensuring the code in the documentation is correct with doctests
- Checking for insensitive language with alex
- Using Github Actions to check automatically run all checks and publish new releases
- Hosting documentation on Read The Docs
- Reference