Skip to content

Latest commit

 

History

History
76 lines (65 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

76 lines (65 loc) · 2.69 KB

Contributing

Committing and Commit Messages

Infernode now uses Semantic-Release and Commitizen to automatically handle versioning. As a result, when using git commit or npm run commit to comply with formatting implemented by Semantic-Release. Upon execution of either command, Commitizen will walk the user through how to author commit messages in the command line.

Steps:

  • Run git add <files> when ready to stage changes
  • Run npm run commit or git commit to format commit messages using Commitizen
  • When ready, push changes up to a branch made for the changes

Pull Requests

  • Development should be performed on branches from dev and PR'd back to dev once complete,
  • Releases will be performed by PRing to main.
  • Pull Requests to dev and main are blocked on passing GHA checks. In order to ensure your PR will pass checks, make sure that:
    • All new dependencies have been included in package.json/package-lock.json
    • All tests are passing locally via npm test
    • All ESLint checks pass locally via npm run lint
    • A new build is successful locally via npm run build
    • The app is functional in production mode via npm run build && npm start and browsing to http://localhost:3000

Please consider the following when filing pull requests:

  • Update working branch from dev
  • Test the above GHA check criteria locally
  • PR title should take the form of a Commitizen commit title
  • Body of PR should take the form of a Commitizen commit body
  • Once approved, the PR author is responsible for squash merging into the destination branch
  • Branches should be deleted after merge

Branch Names

gitGraph
    commit
    branch dev
    checkout dev
    branch feature/add-flame-graph
    checkout feature/add-flame-graph
    commit
    checkout dev
    branch feature/add-graphing-api
    checkout feature/add-graphing-api
    commit
    checkout feature/add-flame-graph
    commit
    checkout dev
    merge feature/add-flame-graph
    branch bugfix/correct-axis-labels
    checkout bugfix/correct-axis-labels
    checkout feature/add-graphing-api
    commit
    checkout dev
    merge feature/add-graphing-api
    checkout bugfix/correct-axis-labels
    commit
    checkout dev
    merge bugfix/correct-axis-labels
    checkout main
    merge dev tag: "v1.2.3"
Loading
  • Use a new branch for each new feature and eventual PR
  • Use the format of "type/descriptive-outcome"
  • Types include:
    • bugfix
    • feature
    • docs
    • testing
    • refactor
    • cicd
  • The descriptive-outcome should describe what will be achieved by merging the branch