Getting started and how to contribute
---------------------------------------

There are multiple ways to contribute to BioNumPy, such as writing documentation, making examples or developing on the code base. For all contributions, follow these steps:

1) :ref:`Set up your development environment<development_setup>`

2) If you do not have push-access to the BioNumPy repository you will need to have a fork of the repository on Github. Push changes to your fork and make a `pull-request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_ on Github when you are done. If you have push-access to the BioNumPy repository, you can push development-branches and make pull-requests from these.

3) Before making your Pull-request, check that everything is working by :ref:`running all tests<testing>`.

4) Follow one of these guides depending on what you want to do:
    * :ref:`Writing documentation<writing_documentation>`
    * :ref:`Making examples<making_examples>`
    * :ref:`Developing on the code base<design_principles>`