From a6767f93c56b2f0f78cf29f6fc4a88e837cc19f7 Mon Sep 17 00:00:00 2001 From: Michael Peter Date: Fri, 5 Jan 2024 15:00:39 -0500 Subject: [PATCH] Update CONTRIBUTING.md (#173) --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b6725c41..f95c5b66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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