Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 2.13 KB
Raw

CONTRIBUTING

Workflow

Working on an issue

The repository is inspired by the gitflow/GitHub flow, you can learn more about it here:

  • Move the issue from the Backlog to the In progress status of the Kanban, memorize the id of the issue (the number after the dash, on the right of the issue's title).
  • Create a branch for your work: tools/git/branch/new/index.bash ${issueId}, it will create and checkout the new branch for your changes.
  • Develop locally, then git add and git commit (with a message respecting the policy explained in the next section). You can also git push your code to GitHub in order to save it.
  • When you are happy about the work you have done, get back the changes from master (merge or rebase) and submit your pull request to master via the GitHub web interface.
  • Move the issue from the In progress to the Review in progress status of the Kanban, your changes will be reviewed and then this issue will be moved to the Reviewer approved Kanban's status.
  • When the pull request is merged in the master branch, the issue has to be moved to the Done status of the Kanban: your work is now part of the releasable code 👏🎉.

Commit message convention

  • We will use the Conventional Commits, version 1.0.0-beta.4 for commit's message.
  • A commit-msg git hook is configured in the repository in order to respect the above mentioned convention: if your commit message does not fit the convention, a git commit will lead to an error.

IDEs

The project targets Visual Studio Code:

  • Install the IDE
  • Install the recommanded extensions mentionned in this repository

After that, you should have many features directly configured in the IDE (code auto-format, linting, ...)

If using another IDE, be prepared to have your code rejected if it does not fit the repository best practices (especially for code formatting).