Skip to content

Methodology

Marcos Lopez Gonzalez edited this page Feb 28, 2018 · 7 revisions

General Policies

Definition of Done

An issue is considered done when it's merged to the branch master.

How to create an issue

  • Keep the scope of the issue as small as possible.
  • In case you need to create an issue with a big scope, add the label "epic" and create subtasks by using a checklist.

How to work on an issue

  1. Make sure the issue is assigned to you.
  2. Create a branch from master with the format: #number_of_issue-Description. Example: #23-EventDateInterpreter.
  3. When you are done create a PR (See section below).

How to create a Pull Request (PR)

  • Do not assign the PR to a project.
  • Reference the issue in a comment in order to see the PR from the issue (only in the title is not enough).
  • If the PR closes an issue, add a closing keyword to close the issue automatically when the PR is merged (https://help.github.com/articles/closing-issues-using-keywords/).
  • Make sure that the issue or issues related are closed when the PR is merged and delete the branch if it's possible.
Clone this wiki locally