Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 1.67 KB
Raw

How to contribute

Thank you for your interest in the package, if you have any suggestion or encountering problem please inform us here. You can also start conversation here to submit new ideas or thoughts

Contribution process

Here is the procedure for contribution

  1. Create a fork of the project here
  2. Clone the repository and install requirements and development requirements with
pip install -r requirements.txt
pip install -r requirements_dev.txt
  1. Create one branch per feature you want to suggest and push them on your fork
  2. Test your work by running
pytest .
  1. Once your feature is finished you have to sync the branch of your fork with the main branch and rebase your work
  2. Create a pull request and make sure the Github actions run successfuly

For small contributions (like typos) you can directly edit in using the Github web editor.

Contribution rule

  • Please follow the Python Naming Conventions and other PEP8 guidelines. Try to avoid trailing whitespaces whenever possible.
  • Fill the docstring of your functions in the numpydoc fashion
  • Test every function and name it in the most explanatory way test_name_of_function_behaviour_tested in the associated file in the directory test

Hide your email adress in commits

Check the box Keep my email adresses private here and run

git config --global user.email "<ID+username>@users.noreply.github.com"