add contributing guidelines (#190)

CONTRIBUTING.rst

@@ -0,0 +1,27 @@
+Contributing to BlueCelluLab
+============================
+
+Thank you for taking the time to contribute!
+
+Reporting Bugs and Suggesting Enhancements
+------------------------------------------
+
+1. Search existing `issues <https://github.com/BlueBrain/BlueCelluLab/issues>`_.
+2. Open a new issue with a clear title and detailed description.
+3. Include steps to reproduce, expected and actual behavior for bugs, or the current and expected behavior for enhancements.
+4. Attach any relevant screenshots or files.
+5. If applicable specify the versions of BlueCelluLab, Python and any relevant dependencies.
+
+Pull Requests
+-------------
+
+1. Fork the repository and create a new branch.
+2. Make your changes.
+3. Run `tox -e lint` to check the code format.
+4. Run the tests with `tox -e py3`.
+5. Add unit tests for the new code.
+6. If applicable add type hints and docstrings.
+7. If applicable update the documentation.
+8. Submit a pull request with a clear description.
+
+Thank you for contributing to BlueCelluLab!

README.rst

@@ -116,6 +116,11 @@ Testing is set up using `tox`:
     tox -e py3  # runs the tests
     tox -e lint  # runs the format checks
 
+Contributing
+============
+
+We welcome contributions to BlueCelluLab! Please see the `CONTRIBUTING.rst <https://github.com/BlueBrain/BlueCelluLab/blob/main/CONTRIBUTING.rst>`_ for guidelines on how to contribute.
+
 Funding & Acknowledgements
 ==========================
 

docs/source/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTING.rst

docs/source/index.rst

@@ -17,5 +17,6 @@
    api.rst
    compiling-mechanisms.rst
    changelog
+   contributing
 
 .. |banner| image:: /logo/BlueCelluLabBanner.jpg