Some basic conventions for contributing to this project.
Please make sure that there aren’t existing pull requests attempting to address the issue mentioned. Likewise, please check for issues related to update, as someone else may be working on the issue in a branch or fork.
When creating a new branch, prefix it with the type of the change (see section Commit Message Format below), the associated opened issue number, a dash and some text describing the issue (using dash as a separator).
For example, if you work on a bugfix for the issue #361, you could name the branch
Want to contribute but don’t know where to start?
Some of the open issues are labeled with prefix
exp/, this is used to mark them as available for contributors to work on. All of these have an attributed difficulty level:
You can use Github filters to list these issues:
Each commit message should include a type, a scope and a subject:
Lines should not exceed 100 characters. This allows the message to be easier to read on github as well as in various git tools and produces a nice, neat commit log ie:
#271 feat(containers): add exposed ports in the containers view #270 fix(templates): fix a display issue in the templates view #269 style(dashboard): update dashboard with new layout
Must be one of the following:
The scope could be anything specifying place of the commit change. For example
You can use the area label tag associated on the issue here (for
containers as a scope...)
The subject contains succinct description of the change:
Our contribution process is described below. Some of the steps can be visualized inside Github via specific
status/ labels, such as
The feature request process is similar to the bug report process but has an extra functional validation before the technical validation as well as a documentation validation before the testing phase.