We are excited that you are interested in contributing to the CORTX project! Since we are open source and have many contributors, it is very important that both our code (and the very necessary comments describing your code) follow consistent standards. In the table below please find all the Code Style Guides that we use for each language as well as which repositories use them. Thanks!
| Language | Repository Names |
|---|---|
| Bash | cortx-s3-server |
| C | cortx-motr cortx-posix cortx-monitor |
| C++ | cortx-s3-server |
| Java | cortx-s3-server |
| Python | cortx-s3-server cortx-ha cortx-posix cortx-monitor |
| Shell | cortx-ha cortx-provisioner |
| YAML: Style Formulae |
cortx-provisioner |
Some repositories have their own style guides, please refer to these repository-specific coding style guides.
- Bash, Python, and C - cortx-hare.
- Python - cortx-manager.
- Typescript, Vue.JS, and HTML - cortx-management-portal.
The CORTX project is inclusive, and we have made it a priority to keep the project as accessible as possible by preferring literal and direct terminology over metaphorical language, slang, or other shorthand wherever possible. For example:
- Use Allowlist instead of Whitelist.
- Replace the Master and Slave terminology, use terminology that more precisely reflects the relationship such as Primary and Secondary or Main and Dev.
To ensure that CORTX software remains available under our current open source licenses, please do not copy-paste any software from other software repositories or from websites such as stackoverflow into any CORTX software.
As they say, 'a picture is worth a thousand words', and we encourage everyone contributing to CORTX to help ensure our documentation is as easy to understand as possible and pictures can help with this. To best enable collaboration and versioning, we further encourage using text-based image formats such as GraphViz and PlantUML and to use the following instructions to embed dynamically rendered images: instructions for GraphViz files and instructions for PlantUML files. This allows us to only commit the text-based view and not have to attempt to commit and keep synchronized the binary views.
