Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.11 KB

How to Contribute

Linting and Formatting

Not standardized. Read (internal) Formatting & Linting.

Best Practices

Development Workflow

We use a modifed version of GitFlow.

  • "feature branches" have a specific prefix:
    • feat/ for features and updates
    • fix/ for bugfixes and hotfixes
    • refactor/ for large internal changes
    • chore/ for no-op changes
    • docs/ for documentation
    • perf/ for performance improvements
    • test/ for test case updates
    • or other "types" from Conventional Commits
  • "develop" branch is usually main,
    but can exist as a long-lived multi-feature branch prefixed with dev/
  • "release branches" (as needed) are prefixed with release/
  • "hotfix branches" are prefixed fix/
  • "master branch" is always main