Contributing via Git GitHub - LucyMHall/Fizzy_O GitHub Wiki

Commit messages

We use semantic commit messages starting with the following keywords:

• chore - set up which does not add a feature
• docs - updating documents eg README
• feat - a feature!
• fix - debugging
• refactor - cleaning up code or linting or other code quality changes
• style - purely styling or prettifying features
• test - adds a new test
• wip - work in progress that doesn't complete a feature

The commit message after the keyword should complete the sentence: "if enabled, this commit will..."

Example

chore: set up react navigation

feat: allow user to log in

Collaborative commits

When mobbing or pairing, commits should include all co-authors

GitHub - creating a commit with multiple authors

Example

$ git commit -m "refactor: add helper for feature tests
>
>
Co-authored-by: Lucy <[email protected]>
Co-authored-by: Monika <[email protected]>
Co-authored-by: Petra <[email protected]>
Co-authored-by: Ruth <[email protected]>"