Contributing to the project is very easy and every little bit counts! Just follow the following steps:
To contribute to this project, follow the next steps:
- Fork (just to external contributors)
- Create issues
- Create branchs
- Follow the commit policy commits
- Submit Pull Request
The issues need title, description, at least one asigned, labels, milestoner (the sprint to conclude)
The Labels used in the project are described in the topic Labels.
To create a issue follow task template or user history template
The main is the production branch, where the stable version of the project will be. It will be closed for commits and for pushes. See the merge policy in the topic Merges para master.
The development branches will be created from the main branch with the default naming x/issue_name
, where x
represents the issue tracking code.
All commits must be mention the issue, for that, just add #<issue_number>
.
#21 Adding contributing guide
By default, the #
character defines a comment line in the commit message file. To resolve this issue, use the command:
git config --local core.commentChar '!'
Pull requests must be made to the main branch following the rules and steps in the topic Merges to main. In the pull request content there should be a clear description of what was done.
Follow template Pull Request.