Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add contributing guidelines #190

Merged
merged 1 commit into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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!
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==========================

Expand Down
1 change: 1 addition & 0 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../CONTRIBUTING.rst
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@
api.rst
compiling-mechanisms.rst
changelog
contributing

.. |banner| image:: /logo/BlueCelluLabBanner.jpg