👏 First thing first... Thank you for taking the time to contribute to Centreon project ! 👏 Much appreciated ! 🤘
This article contains guidelines for contributing to Centreon project.
- Where should I report ?
- I have an issue to report
- I have a suggestion of enhancement
- I have a pull request to submit
Any people that wants to contribute and participate in developping the project must respect Centreon Code of Conduct. Please report any unacceptable behavior to community@centreon.com.
Advise: Centreon GitHub is meant for opening issues (code related), feature requests and so on. It is not meant for support. Please refer to the following available ressources, you'll get an answer from a Centreon team or community member.
Centreon community can contribute in many ways to the project.
Issues and feature requests should be done on the appropriate repositories. Here are the repositories maintened by Centreon:
| Modules |
|---|
| centreon-broker |
| centreon-engine |
| centreon-clib |
| centreon-connectors |
| centreon-plugins |
| centreon-dsm |
| centreon-vmware |
Before reporting an issue please make sure that it has not been already reported by checking Centreon Bug Tracker
If your issue has not been reported yet, then the issue should be opened using the following template ISSUE_TEMPLATE.md
Any ideas, enhancements, feature requests are more than welcome. Feature requests should be opened by using the following template FEATURE_REQUEST.md
You have been working on Centreon base code and want to submit it to us. Well... Again you are more than welcome and thank you in advance ! 👏
The pull request should respect the some requirements that can found in the following template PULL_REQUEST_TEMPLATE.md
Notice: Any pull request that does not respect those requirements will be legitimately rejected !
The commit format should follow this commit template message
<type>(<scope>): <subject>
<body>
<footer>
The format explanation can be found here.
The body section needs to be clear, made of complete sentences introducing the purpose of the commit and the context, making code reviews much easier.
The footer should contain reference(s) to the ticket(s) related to the commit. Applied to the sample ticket
Refs: #5567 (GitHub) or MON-2234 (Jira)
The type can refer to
- feat: adding a feature
- fix: adding a patch
- enh: adding an enhancement
- docs: adding documentation changes
- style: fixing coding style issues
- refactor: code refactoring
- test: adding new tests or fixing old ones
- chore : updating project construction files (Jenkins files, CMakefile, gulp, webpack ...)
The scope is defined by project. Scopes for Centreon Open Source project can be found here.
Centreon software is made of several languages. For each language a specific coding style must be respected.
Since the 18.10 version of Centreon REACT has been introduced and Centreon follows the airbnb react coding style.
For other languages, coding style rules are defined in Centreon GitHub repository
If you want to visualize and suggest modification to the documentation through a pull request you can check the HOW TO build the documentation section here