CONTRIBUTING.md

Commit Message Header

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: engine|game|model|view or subpackage
  │
  └─⫸ Commit Type: build|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Type

Must be one of the following:

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the fr.ubx.poo package affected (as perceived by the person reading the changelog generated from commit messages).

The following is the list of supported scopes:

• engine
• game
• model
• view
• model/bonus
• model/decor
• model/go
• view/image
• view/sprite

Summary

Use the summary field to provide a succinct description of the change:

• use the imperative, present tense: "change" not "changed" nor "changes"
• don't capitalize the first letter
• no dot (.) at the end