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
## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))
## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
(cherry picked from commit 3dcf919)
- Release note makes sense to a user of the library
20
-
- If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
21
-
- Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
3
+
<!-- Provide an overview of the change and motivation for the change -->
4
+
5
+
## Testing
6
+
7
+
<!-- Describe your testing strategy or note what tests are included -->
8
+
9
+
## Risks
10
+
11
+
<!-- Note any risks associated with this change, or "None" if no risks -->
12
+
13
+
## Additional Notes
14
+
15
+
<!-- Any other information that would be helpful for reviewers -->
Copy file name to clipboardExpand all lines: docs/contributing.rst
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,23 @@ Correctness and code style are automatically checked in continuous integration,
38
38
various tools including Flake8, Black, and MyPy. This means that code reviews don't need to worry about style
39
39
and can focus on substance.
40
40
41
+
Pull Request Requirements
42
+
~~~~~~~~~~~~~~~~~~~~~~~~~
43
+
44
+
When submitting a pull request, ensure the following requirements are met:
45
+
46
+
* **PR title follows conventional commit standard** - See the `Branches and Pull Requests`_ section for details.
47
+
* **All changes are related to the pull request's stated goal** - Keep changes focused and avoid scope creep.
48
+
* **The change includes tests OR the PR description describes a testing strategy** - All code changes should be tested appropriately.
49
+
* **The change includes or references documentation updates if necessary** - Update user-facing documentation when adding new features or changing behavior.
50
+
* **Backport labels are set if applicable** - Apply appropriate backport labels for fixes and CI changes as described in the `Backporting`_ section.
51
+
* **Avoids breaking API changes** - Follow the :doc:`versioning policy <versioning>` to maintain backward compatibility.
52
+
* **The PR description includes an overview of the change** - Clearly describe what the change does and why it's needed.
53
+
* **The PR description articulates the motivation for the change** - Explain the problem being solved or the improvement being made.
54
+
* **The PR description notes risks associated with the change, if any** - Document any potential impacts or considerations.
55
+
* **Newly-added code is easy to change** - Write maintainable code that follows established patterns.
56
+
* **Testing strategy adequately addresses listed risks** - Ensure tests cover the scenarios and edge cases relevant to your change.
57
+
41
58
Branches and Pull Requests
42
59
--------------------------
43
60
@@ -54,6 +71,7 @@ in pull request names are enumerated :ref:`in the release notes documentation<re
54
71
55
72
Pull requests that change the library's public API require a :ref:`release note<release_notes>`.
56
73
If your pull request doesn't change the public API, apply the ``no-changelog`` label.
74
+
Release notes should be written from the user's perspective and clearly explain the impact or benefit of the change.
57
75
58
76
Once approved, pull requests should be merged with the "Squash and Merge" option.
0 commit comments