Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 714 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 714 Bytes
Raw

Contribution

Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request.

Please consider the following :

  1. Fork it!
  2. Create your feature branch (under dev branch)
  3. Add your new features or fix detected bugs
  4. Add standard docstring to your functions/methods
  5. Add tests for your functions/methods (doctest, Test folder)
  6. Update README.md (if needed)
  7. Update Document.ipynb (if needed)
  8. Pass all CI tests
  9. Update CHANGELOG.md
    • Describe changes under [Unreleased] section
  10. Update AUTHORS.md
    • Add your name under # Other Contributors # section
  11. Submit a pull request into dev (please complete the pull request template)