Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
mpeterdev authored Jan 5, 2024
1 parent 9456bd2 commit a6767f9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
## Branching

Branch directly off `main` and use an appropriate prefix (`feat/`, `chore/`, `fix/`, etc)

## PRs

Use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in PR descriptions to automatically close relevent issues when the PR is merged. E.g. `Closes #10`

## Syncing Component Updates with Engine Updates

As much as possible, please update demo components in `apps/demos` in the same PR as the engine modifications which necessitate the component updates. You may wish to get the engine change portion of your PR reviewed and approved before adding the component changes, in case review comments lead to alterations to the implementation or resultant syntax

0 comments on commit a6767f9

Please sign in to comment.