Skip to content

Latest commit

 

History

History
22 lines (22 loc) · 1.46 KB

CONTRIBUTING.rst

File metadata and controls

22 lines (22 loc) · 1.46 KB

Contributing


1. Fork the repository. Here is a guide how to do this:
2. Before you make changes, make sure you synchronized with the repository.
4. Edit the python scripts (implement your improvements).
5. Edit the version number in setup.py.
Therefore, somebody could identify, that he is using a package with your changes later on,
this will allow rechecking the results from the past, as every version is saved in git and can be restored.
6. Install the package (as in the section "How to install" described).
7. Restart your integrated development environment (IDE)
eg. Spyder, VSCode, ... , so the IDE reloads all packages, and the changes are applied
(depends on the IDE, whether this is required).
8. Test your code.
9. Git add filenames, git commit -m "comment", git push to your fork.
10. If you successfully pushed to your repository, there should be a notification, when you log into
the web-version of github, to pull a request (this is the inquiry to make your changes applied
to the main repository, so all could profit from your changes). Describe the issue you where solving
and how and why it is solving the problem.
11. Hope that the maintainer approves your work and merges it.