Contributing

Every contribution is welcome. If not with the concrete pull request, then as:

1. A mention on the social media
2. Giving any kind of feedback on the communication channels

3. A bug report on https://github.com/zmasek/shamrock/issues

   1. Make sure it’s not a duplicate of a bug already reported
   2. Include operating system name and version, essentially, the environment you’re running
   3. How to reproduce the bug in detail
   4. What were you trying to do
   5. What did you expect to happen
   6. Include screenshots if necessary
   7. Help us help you

4. Fix existing bugs and implement new features

   1. Fork the repository
   2. Clone it locally
   3. cd into the repository
   4. pipenv install –dev (make sure that pipenv is installed on your system first)
   5. pipenv run pre-commit install
   6. If you want to test it from the environment: pipenv run python setup.py develop
   7. Make modifications
   8. pipenv run coverage run –source . tests && pipenv run coverage report -m
   9. It is easier if you keep commits isolated properly. It helps you get your PR merged

   10. Before making a pull request make sure:

       1. You have the docs updated
       2. The tests are added/changed if necessary
       3. The test pass successfuly
       4. You add yourself in the AUTHORS.rst as a contributor

   11. Push back and submit a pull request

5. Do the same for expanding the documentation. A project is only as good as its documentation