Repository Policy

Git Policy

Commits

• Commits must be made in English

• They must be easy to understand, short and simple titles.

• Start with Uppercase letters.

• Should start with a verb in infinitive form describing what that commit will do. Ex: "Create new home Screen"

• Commit in pair execute the following steps:

  • In command line, type git commit -s
  • When the text editor appears, write the commit message in file's first line.
  • Under the line containig Signed-off-by: [your_username] <[your_email]>,
    write Signed-off-by: [partner_username] <[partner_email]>
  • Save file
  • And it's done.

• Example of pairing commit:

Fix bugs

Signed-off-by: Lucas <lucas465@hotmail.com>
Signed-off-by: pablodiegoss <pablodiegoss@hotmail.com>

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# No ramo TS_Fix_bugs
# Your branch is up-to-date with 'origin/master'.
#
# Mudanças a serem submetidas:
#       modified:   main/main.py
#

Branches

We have two important branches, Devel and Master. None of these should be commited directly by the team for any feature.

For every feature a new branch should be created based on the lastest Devel commit. The name of the branch shall follow this model: US_[Name of the User Story]. When the feature is completed and the build on TravisCI is marked as OK, a pull request needs to be created on Devel and accepted by another member of the team that has not worked on the feature.

Conflicts

If a pull request causes any kind of conflict, it should be solved first and then a new pull request should be created.

Continuous integration

TravisCI will be continuously building and testing our project and commits on Github, if any test fail or if your code doesn't follow our stylesheet, your commit build will fail and it will not be merged into devel until fixed.