There are multiple ways to contribute to GrimoireLab. You can help other users solve their issues running the platform, report issues you might have found using in our software, propose new ideas, improve documentation, and even write code to add new features or fix existing bugs.
The following is information and general guidelines for collaborating with us.
Before opening a new discussion, bug, issue, etc, please check if similar one has already been reported. This helps us avoid duplication of effort and keeps our discussions and issues focused.
Also, please check our Code of Conduct. GrimoireLab is part of the CHAOSS Collaborative Project and any participation in their projects is subject to their Code of Conduct.
If you find an error while running the platform, we would appreciate you opening an issue to report it.
As GrimoireLab is built by several components across some GitHub repositories, You may not know exactly where to open the issue. Unless you know exactly on which component the bug is, open the issue on the main repository. Maintainers will move the issue if they see the issue is related to another repository.
If you have ideas for improvements or new features, feel free to open a new discussion or issue to share them. We appreciate well-documented enhancement suggestions. You can also have at look to our ROADMAP to check if your proposal is aligned with the current direction of the platform.
All contributions to current repositories in GrimoireLab will be received as pull requests in the corresponding repository. GitHub has a complete guide on collaborating via pull requests but, in short, you will do the following:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and test them thoroughly.
- Create a pull request (PR) with a clear title and description.
- Ensure your PR follows our coding standards.
If you're interested in contributing with code, please also have a look at the specifics in our CONTRIBUTING WITH CODE document.
If you discover a vulnerability, please follow the instructions described in the Security Policy document to report your findings.
In GrimoireLab we use the communication channels listed below, each one of them intended for a specific purpose.
We use this site for:
- General announcements, such as information about releases.
- Questions and community support.
- General discussions about the future of the project, relationship with other projects, new features or changes that don't fit in other communication channels.
- Discussions related to the management of the project, including the relationship with the CHAOSS Software Technical Committee.
Most of the technical work is discussed here, including upgrades and proposals for upgrades, bug fixing and feature requests.
You can fin us on #grimoirelab
channel at CHAOSS Slack.
We use the channel for pinging people, sharing updates, quick and informal discussions, questions and answers, etc. Please, remember that developers in the channel won't always be available. However, anyone interested in the project is welcome to join the channel and start a discussion.
You can publicly share how you or your organization are using GrimoireLab by adding an entry to the ADOPTERS file.