Skip to content

Commit 7a6c47b

Browse files
authored
Touch up contributing guide (#4410)
1 parent 27a3b5c commit 7a6c47b

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

documentation/CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ By taking these extra steps to test your contributions, you help maintain the hi
8080

8181
### Testing Your Contributions
8282

83-
Ensuring the quality and reliability of `esp-hal` is a shared responsibility, and testing plays a critical role in this process. Our GitHub CI automatically checks the buildability of all examples and drivers within the project. However, automated tests can't catch everything, especially when it comes to the nuanced behavior of hardware interactions. So make sure that the example affected by your change works as expected.
83+
Ensuring the quality and reliability of `esp-hal` is a shared responsibility, and testing plays a critical role in this process. Our GitHub CI automatically checks the buildability of all examples and drivers within the project. However, automated tests can't catch everything, especially when it comes to the nuanced behavior of hardware interactions. So make sure that the example affected by your change works as expected.
8484

8585
Further steps that can (or should) be taken in testing:
8686

@@ -119,16 +119,17 @@ This will use `rustfmt` to ensure that all source code is formatted correctly pr
119119
* Fill the pull request template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
120120
* [Link your PR] to any relevant issues it addresses.
121121
* [Allow edits from maintainers] so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
122-
* Make sure you add an entry with your changes to the [Changelog]. Also make sure that it is in the appropriate section of the document.
123-
* Make sure you add your changes to the current [migration guide].
122+
* Make sure you add an entry with your changes to the relevant crate's changelog.
123+
* Place your entry in the appropriate section of the upcoming version
124+
* Make sure you reference the right pull request at the end of the changelog entry. If you made a change in PR 1234, end your changelog entry with `(#1234)`.
125+
* You can amend existing changelog entries, when appropriate. In this case, just append your PR number to that entry's, like `(#789, #1234)`.
126+
* If your change requires user code to be changed, make sure you add your changes to the next version's migration guide.
124127
* We may ask for changes to be made before a PR can be merged, either using [suggested changes] or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
125128
* As you update your PR and apply changes, mark each conversation as [resolved].
126129
* Resolve merge conflicts if they arise, using resources like [this git tutorial] for help.
127130

128131
[Link your PR]: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
129132
[Allow edits from maintainers]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork#enabling-repository-maintainer-permissions-on-existing-pull-requests
130-
[Changelog]: esp-hal/CHANGELOG.md
131-
[migration guide]: esp-hal/MIGRATING-0.20.md
132133
[suggested changes]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request
133134
[resolved]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#resolving-conversations
134135
[this git tutorial]: https://github.com/skills/resolve-merge-conflicts

0 commit comments

Comments
 (0)