Skip to content

Latest commit

 

History

History
61 lines (33 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

61 lines (33 loc) · 1.85 KB
Raw

How to contribute

Did you find a bug? / Do you want to suggest somthing?

Do you want to fix an issue?

  • Create a branch formatted as fix/<ISSUENUMBER>-<TITLE> for bug fixes or feature/<ISSUENUMBER>-<TITLE> for features, example: fix/4221-infinite-loop.

  • Submit a pull request.

  • Once validated, merge to PR to master and remove the source branch (with git branch -D <branch_name>.

How to title commits?

  • Follow the guidelines at https://cbea.ms/git-commit/

  • Use imperative tense (avoid past tense).

  • The title of the commit must be a summuary of the content and not be too long (less than 50 characters).

  • The title of the commit must start by three letters describing the nature of the commit surrond by []

    • Bug Fix [FIX]
    • Refacto [REF]
    • Adding of a functionnality [ADD]
    • Remove code [REM]
    • Update code [UPD]
    • Conflicts fix [MER]

  • Prefer putting detailed informations inside the commit's description.

  • Example:

    $> git commit -m '[FIX] infinite loop when pressing Alt-F4

This was caused by a missing check in the event loop
The program now checks when the window is set to close'

DOs and DONTs

  • ❌ DONT: Push to the master (or main) branch for any reason, please submit a PR instead.

  • ❌ DONT: Create a pull request of more than 200 addings

  • ❌ DONT: Create a branch with your username as the title

  • ✔️ DO: Commit often! allows everyone to see your progress and eventually make suggestions on it.

  • ✔️ DO: Format your code, using either .clang-format directly or your IDE's capabilities (and yes, VSCode can format your code for you!)

Thanks! ❤️ ❤️ ❤️