Contributing and Community Guidelines ===================================== MotilA is an open-source project and improves through contributions from its users. Contributions can range from bug reports and documentation improvements to new features and extensions of the analysis pipeline. How to contribute ----------------- If you are interested in contributing to MotilA, the recommended entry points are: * reporting bugs or problems you encounter * suggesting improvements to the documentation or examples * submitting pull requests with code changes Please use the `GitHub issue tracker `_ to report bugs, request features or ask for clarification. For code changes and larger contributions, please open a pull request against the main repository. Contribution guidelines ----------------------- The repository contains a dedicated `contribution guide `_ in the file ``CONTRIBUTING.md``. It describes in more detail: * how to set up a local development environment * the preferred workflow for branching and pull requests * conventions for commit messages * what information to include when opening issues Before opening a pull request, please make sure that * the code is formatted consistently with the existing code base * tests (if present) pass locally * changes are documented in the docstrings and, where appropriate, in the documentation pages Code of Conduct --------------- All interactions in the MotilA project are governed by a `Code of Conduct `_ based on the `Contributor Covenant `_. By participating in the project, you agree to abide by these guidelines. If you experience or observe behaviour that violates the Code of Conduct, please report it `via email `_ to the maintainer (Fabrizio Musacchio). Where to start -------------- If you are looking for a first contribution, the issue tracker may contain tickets labelled as good starting points (for example documentation improvements or small enhancements). You are also welcome to open an issue to discuss ideas for new features or extensions of the pipeline before starting to implement them. Thank you for considering contributing to MotilA 🙏