Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (33 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

34 lines (33 loc) · 1.39 KB

Contributing Guidelines

Branches

  • main: Always stable. Production builds happen from here.
  • dev: All new work is merged here first.

Contributing Workflow

  1. Checkout dev and pull latest changes
  2. Create a new branch from dev:
    • feature/xyz: New feature
    • fix/xyz: Bugfix
  3. Push your branch and open a PR into dev
  4. Once tested, open a PR from dev → main to trigger a production release

Commit Style

As of v1, ds-chef will adhere to Conventional Commits and begin using more tightly-scoped commits rather than bundled ones. Don't overthink it, pick whatever feels close enough.

  • feat: add login button
  • fix: correct scroll behavior
  • refactor: simplify layout
  • docs: fix typo in CONTRIBUTING guide,
  • chore: - for any misc. upkeep like configs
  • style: - code style—not CSS

Procedures for maintainers

Releasing dev to main (production)

  1. Ensure dev is clean/up to date 
    git checkout dev
git pull origin dev
  2. Before merging to main, it's important to bump the version in package.json and others since it's displayed in the app. This will automatically create a tagged commit. 
    npm version <newversion> | minor | patch
git push origin dev --follow-tags
  3. Create a PR from dev to main.
  4. Create a GitHub release with changelog/description