Why contribute? Read our propaganda at We want YOU to contribute to this book!.

25.7.2. How to contribute¶

Something is wrong/misleading: Fix it with a pull request or raise the issue by creating a JIRA ticket. If you are unsure about it, you can ask on questions.belle2.org before.
You notice that something is missing:
- If you’re not sure whether it belongs here, ask the librarians, e.g. by creating a JIRA ticket or per email. You can either assign the JIRA ticket to someone you like or submit a pull request for it yourself (preferred).
- If it is already marked as a todo item, check if someone else is working on it (search on JIRA) and if not, submit a pull request

Understanding Sphinx and RST¶

This webpage is built with Sphinx using source files in reStructuredText (*.rst) format.

See How to document your code with Sphinx to learn more about these tools.

Hint

If you want to learn sphinx by looking at the sources of various pages, click on the View page source button on the top right of the web page.

Hint

The source file of each file is apparent from the URL. E.g. this page has the URL .../online_book/how_to_contribute.html, so your source file is in ${BELLE2_LOCAL_DIR}/online_book/how_to_contribute.rst.

Submitting a PR¶

You need to

Create a development setup as explained in Development Setup
Change to a new branch feature/describe-your-change or bugfix/something (if your PR is based on a JIRA issue BII-XXXX you can include it in the name feature/BII-XXXX-improve-docs). You will not be able to push your branch if it isn’t prefixed with feature/ or bugfix/
Make your changes
Optionally: Preview them locally as described in How to document your code with Sphinx
Push your branch
Create a PR following the guidelines outlined at Opening a pull request