Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
In case you identified a security issue on the project, please report it to security@rero.ch.
Report bugs at github.com/rero/sonar/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "feature" or "enhancement" is open to whoever wants to implement it.
SONAR could always use more documentation, whether as part of the official SONAR docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at github.com/rero/sonar/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome
Ready to contribute? See the installation procedure to setup a local development environment.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests and should not decrease test coverage.
- Your code is as clear as possible and sufficiently documented (comments, docstrings, ...).
- All tests on GitHub Actions should pass before merging.
Commit messages follow the Conventional Commits guidelines.