.. _contributing:

Contributing
============

    *Work in progress...*

The project codebase is hosted at on GitHub: `plasmalab <https://github.com/hetsko/plasmalab)>`_

See ``README.md`` and ``README_DEV.md`` files in the repository for basic info.
Continue with tutorials on this docs page to get more inside on specific parts
of the project. Check issues for inspiration on what to do. Then follow the
standard procedure:

1. Create an aptly named branch from the ``develop`` branch. Use names like
    ``feature/something`` or ``fix/something``.
2. Commit and push changes to this branch.
3. Create units tests for your code and/or run existing unit tests to check for errors.
4. Create a pull request to ``develop`` and wait for a review.