Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (22 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.18 KB

Guidelines - Contributing to "WTF Should I Cook?"

WTF Should I Cook? is developed using a trunk-based approach. As such all Pull Requests (PRs) should be branched from main and ideally, branch naming should follow this pattern: <PURPOSE>/<SHORT_DESC>

Where:

  • <PURPOSE>: Is one of the following: feature or feat (for a new feature), bugfix (for... a bug fix), chore or docs for very trivial tasks (like fixing typos) or updates to the documentation.
  • <SHORT_DESC>: A short, human readable description of the topic addressed by the branch.

As such the process for starting on a new feature (for example) would be:

git checkout main
git pull origin main
git checkout -b feature/add-this-new-shiny-thing

All PRs, once merged should leave the main branch in a potentially deployable state. It's okay to have only one part of a feature merged as long as this doesn't break existing features, and disable those which are incomplete.

Also as a courtesy to others, prior to pushing a branch to the repository please run code formatting and linting tools. (For the backend, black is available)