Contributing to JOAN

We are more than happy to accept contributions!

How can I contribute?

  • Reporting bugs and issues
  • Feature requests
  • Improving documentation
  • Code contributions

Reporting bugs and issues

If you find bugs or have other issues, use our Issue tracker. Before creating a new issue, please check if a similar issue has already been reported. Select the 'bug' template in the issue tracker and fill out as much as you can. Only then we can properly address the bug! Also check the documentation.

Feature requests

Check the issue tracker list and filter on the label feature to check if a similar feature has been already requested. If so, please add information to the already existing feature if something is missing. Please submit your request as a new issue and select the 'feature request' template in the issue tracker.

Improving documentation

Everyone can agree that good documentation is awesome to have. If you feel something is missing in the documentation, please don't hesitate to open an issue to let us know. Even better, if you think you can improve it yourself, it would be a great contribution!

We build our documentation with MkDocs based on the Markdown files inside the docs folder. You can either directly modify them on the GitLab repository or locally on your machine.

Once you are done with your changes, please submit a pull request.

Tip

You can build and serve it locally (at http://127.0.0.1:8000) by running mkdocs in the project's main folder.

  > sudo pip install mkdocs
  > mkdocs serve

Code contributions

The code is never done, so if you want to help out, awesome!

Before starting hands-on coding, please check out our issue board to see if we are already working on that particular issue. In case of doubt or to discuss how to proceed, please contact one of us.

Coding standard

Please follow the current coding standard when submitting new code.

Pull-requests

Once you think your contribution is ready to be added to JOAN, please submit a pull request.

Try to be as descriptive as possible when filling the pull-request description. Adding images and gifs may help people to understand your changes or new features.

Checklist
  • [ ] Your branch is up-to-date with the master branch and tested with latest changes
  • [ ] Extended the README / documentation, if necessary
  • [ ] The code adheres to PEP8, please use flake8 or pylint to check the code for consistency (see coding standard)
  • [ ] Code compiles correctly