Skip to content

Contributing

Jump to bottom
Federico Brigante edited this page Feb 19, 2024 · 4 revisions

Part of the Getting started guide.

Branch naming

We roughly follow the Gitflow/GitHub flow naming convention. For bug fixes and enhancements to the main branch, use feature/XXX-issue-name. For bug fixes to a release branch (found during QA), use bugfix/XXX-issue-name

Commits

When you commit, pre-commit will run prettier and other checks on the code. NOTE: if pre-commit modifies a file during a commit, you have to re-stage it in the Git commit.

Don't worry about cleaning up the commit history before submitting a PR. We squash merge the PR, so all the commits will be merged into a single commit

Altering/fixing dependencies

  1. Fork their repo to your GitHub account
  2. Run npm install yourname/forkedreponame
  3. Open a PR to their repo or leave as "Future work"
  4. Restore install from npm after the upstream repo has been fixed
Clone this wiki locally