You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ or `-s`, e.g.
25
25
git commit --signoff
26
26
```
27
27
28
-
Finally, make sure to sign your commits using a GPG key. See the instructions [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) for more information. A green `verified` label will appear next to your commit on GitHub if it is successfully signed.
28
+
Finally, **make sure to sign your commits** following the instructions provided by [GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Note that we run [GitHub's commit verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) tool to check the commit signatures. A green `verified` label should appear next to **all** of your commits on GitHub.
29
29
30
30
### Style Guide
31
31
@@ -35,13 +35,14 @@ See our [Macaron Style Guide](./docs/source/pages/developers_guide/style_guide.r
35
35
36
36
1. Ensure there is an issue created to track and discuss the fix or enhancement
37
37
you intend to submit.
38
-
2. Fork this repository.
39
-
3. Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, e.g. `1234-fixes`.
40
-
4. The name of the PR should follow the convention of [commit messages](#commit-messages).
38
+
2. Fork this repository including the `staging` branch. In Macaron, the `staging` branch is the active development branch and contains the most recent changes.
39
+
3. Create a branch in your fork to implement the changes. Make sure to create your branch from the `staging` branch and not `main`. We recommend using the issue number as part of your branch name, e.g. `1234-fixes`.
40
+
4. The title of the PR should follow the convention of [commit messages](#commit-messages).
41
41
5. Ensure that any documentation is updated with the changes that are required by your change.
42
42
6. Ensure that any samples are updated if the base image has been changed.
43
43
7. Submit the pull request. *Do not leave the pull request blank*. Explain exactly what your changes are meant to do and provide simple steps on how to validate. your changes. Ensure that you reference the issue you created as well.
44
-
8. We will assign the pull request to 2-3 people for review before it is merged.
44
+
8. Choose `staging` as the base branch for your PR.
45
+
9. We will assign the pull request to 2-3 people for review before it is merged.
0 commit comments