If you are interested in contributing to
rising, you can either implement a new feature or fix a bug.
For both types of contributions, the process is roughly the same:
Open an issue in this repo and discuss the issue with us! Maybe we can give you some hints towards implementation/fixing.
Create a new branch (in your fork if necessary) for the implementation of your issue. Make sure to include basic unittests.
After finishing the implementation, send a pull request to the correct branch of this repo (probably master branch).
Afterwards, have a look at your pull request since we might suggest some changes.
If you are not familiar with creating a pull request, here are some guides:
rising on your machine, here are some tips:
Uninstall all existing installs of
pip uninstall rising pip uninstall rising # run this command twice
Clone a copy of
git clone https://github.com/PhoenixDL/rising.git cd rising
Install it via
python setup.py build develop
pip install -e .
This mode will symlink the python files from the current local source tree into the python install.
Hence, if you modify a python file, you do not need to reinstall
again and again
In case you want to reinstall, make sure that you uninstall
rising first by running
pip uninstall rising
python setup.py clean. Then you can install in
build develop mode again.
To improve readability and maintainability, PEP8 Style should always be followed
maximum code line length is 120
maximum doc string line length is 80
All imports inside the package should be absolute
If you add a feature, you should also add it to the documentation
Every module must have an
All functions should be typed
Keep functions short and give them meaningful names
Unittests are located under
tests/. Run the entire test suite with
python -m unittest
rising root directory or run individual test files, like
python test/test_dummy.py, for individual test suites.
Better local unit tests with unittest¶
Testing is done with a
You can run your tests with coverage by installing ´coverage´ and executing
coverage run -m unittest; coverage report -m;
inside the terminal. Pycharm Professional supports
Run with coverage directly.
Furthermore, the coverage is always computed and uploaded when you execute
git push and can be seen on github.
rising uses an adapted version of google style
for formatting docstrings. Opposing to the original google style we opted to not duplicate the typing from the function
signature to the docstrings.
Length of line inside docstrings block must be limited to 80 characters to
fit into Jupyter documentation popups.