Skip to content

Commit 439f2bc

Browse files
committed
Update Code Contribution
1 parent 2b8f688 commit 439f2bc

File tree

4 files changed

+99
-61
lines changed

4 files changed

+99
-61
lines changed

docs/Development/Policies-and-Procedures/Code-Contribution/Pull-Request-Checklist.md

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,52 @@
1-
# Pull Request Checklist
1+
# PR Checklist as of November 7, 2025
22

3-
To help provide more accurate and up-to-date information converning pull request and commit message formatting and requirements, all new pull requests will be scanned for common issues and if any are found, a checklist will be added to the PR explaining the issue and recommending action. As updates are made to the PR, the checklist will be updated and when all items have been resolved, the checklist will be deleted.
4-
5-
/// note
6-
Having open checklist items won't necessarily prevent your PR from being merged. It isn't perfect and false positives are possible. If you have suggestions for additional checklist items or you believe the criteria or display text for an existing check is faulty, let us know.
7-
///
3+
**Attention!** This pull request may contain issues that could prevent it from being accepted. Please review the checklist below and take the recommended action. If you believe any of these are not applicable, just add a comment and let us know.
84

9-
## PR Checklist as of March 2, 2025
5+
- [ ] Contributor License Agreement is not signed yet.
106

11-
**Attention!** This pull request may contain issues that could prevent it from being accepted. Please review the checklist below and take the recommended action. If you believe any of these are not applicable, just add a comment and let us know.
7+
- [ ] There is a Merge commit in this PR. The Asterisk project doesn't use Merge commits so this commit must be removed.
128

139
- [ ] There is more than 1 commit in this PR and no PR comment with a `multiple-commits:` special header. Please squash the commits down into 1 or see the [Code Contribution](https://docs.asterisk.org/Development/Policies-and-Procedures/Code-Contribution/) documentation for how to add the `multiple-commits:` header.
14-
- [ ] The PR title does not match the commit title.
15-
- [ ] The PR description does not match the commit message body.
16-
- [ ] The commit message doesn't contain a blank line after the title.
17-
- [ ] The <mmsg_body> has a malformed `Fixes` or `Resolves` trailer. The `Fixes` or `Resolves` keywords MUST be preceeded by a blank line and followed immediately by a colon, a space, a hash sign, and the issue number. A malformed trailer will prevent the issue from being automatically closed when the PR merges and from being listed in the release change logs.<br> Regular expression: `^(Fixes|Resolves): #[0-9]+`.<br> Example: `Fixes: #9999`.
18-
- [ ] The `<keyword>` trailer in the <msg_body> must be predeeded by a blank line and the `<keyword>` keyword itself must be followed by a colon and a space before the actual note text. This is to ensure that the note is properly formatted and displayed in the release change logs.
19-
- [ ] The <first_body> has a `Fixes` or `Resolves` special trailer but the <second_body> has neither. A properly formatted `Fixes` or `Resolves` trailer is required in the PR description to allow the issue and the PR to be cross-linked and for the issue to be automatically closed when the PR merges. It's also required in the commit message to allow the issue to be listed in the release change logs.
20-
- [ ] The are no `cherry-pick-to` headers in any comment in this PR. If the PR applies to more than just the branch it was submitted against, please add a comment with one or more `cherry-pick-to: <branch>` headers or a comment with `cherry-pick-to: none` to indicate that this PR shouldn'tbe cherry-picked to any other branch. See the [Code Contribution](https://docs.asterisk.org/Development/Policies-and-Procedures/Code-Contribution/) documentation for more information.
21-
- [ ] An Alembic change was detected but a commit message UpgradeNote with at least one of the 'alembic', 'database' or 'schema' keywords wasn't found. Please add an UpgradeNote to the commit message that mentions one of those keywords notifying users that there's a database schema change.
10+
11+
- [ ] The PR title does not match the commit title. This can cause confusion for reviewers and future maintainers. GitHub doesn't automatically update the PR title when you update the commit message so if you've updated the commit with a force-push, please update the PR title to match the new commit message body.
12+
13+
- [ ] The PR description does not match the commit message body. This can cause confusion for reviewers and future maintainers. GitHub doesn't automatically update the PR description when you update the commit messageso if you've updated the commit with a force-push, please update the PR description to match the new commit message body.
14+
15+
- [ ] A commit message doesn't contain a blank line after the title.
16+
17+
- [ ] The PR description and/or commit message has unsupported trailers after the `Resolves`, `Fixes`, `UserNote`, `UpgradeNote` and/or `DeveloperNote` trailers. Please refrain from adding unsupported trailers as theywill confuse the release change log generation. If you really need them, please move them before any of thesupportred trailers and ensure there's a blank line after them.
18+
19+
- [ ] The PR description and/or commit message has a malformed `Fixes` or `Resolves` trailer. The `Fixes` and `Resolves` keywords MUST be preceeded by a blank line and followed immediately by a colon, a space, a hash sign(`#`), and the issue number. If you have multiple issues to reference, you can add additional `Fixes` and`Resolves` trailers on consecutive lines as long as the first one has the preceeding blank line. A malformedtrailer will prevent the issue from being automatically closed when the PR merges and from being listed in the release change logs.<br> Regular expression: `^(Fixes|Resolves): #[0-9]+$`.<br> Example: `Fixes: #9999`.
20+
21+
- [ ] The PR is cross-referenced by one or more issues () but doesn't contain any `Fixes` or `Resolves` trailers. A missing trailer will prevent the issue from being automatically closed when the PR merges and from being listed in the release change logs.<br> Regular expression: `^(Fixes|Resolves): #[0-9]+$`.<br> Example: `Fixes: #9999`.
22+
23+
- [ ] The PR description and/or commit message references one or more issues ( ) without a `Fixes:` or `Resolves:` keyword. Without those keywords, the issues won't be automatically closed when the PR merges and won't be listed in the release change logs.<br>Regular expression: `^(Fixes|Resolves): #[0-9]+$`.<br> Example: `Fixes: #9999`.
24+
25+
- [ ] The PR description and/or commit message has malformed `UserNote`, `UpgradeNote` and/or `DeveloperNote` trailers. The `UserNote`, `UpgradeNote` and `DeveloperNote` keywords MUST be predeeded by a blank line and followed immediately by a colon and a space before the actual note text. This is to ensure that the note is properly formatted and displayed in the release change logs.
26+
27+
- [ ] Either the PR description has a `Fixes` or `Resolves` special trailer but the commit mesage doesn't orthe other way around. A properly formatted `Fixes` or `Resolves` trailer is required in the PR description to allow the issue and the PR to be cross-linked and for the issue to be automatically closed when the PR merges. It's also required in the commit message to allow the issue to be listed in the release change logs.
28+
29+
- [ ] The are no `cherry-pick-to` headers in any comment in this PR. If the PR applies to more than just thebranch it was submitted against, please add a comment with one or more `cherry-pick-to: <branch>` headers ora comment with `cherry-pick-to: none` to indicate that this PR shouldn't be cherry-picked to any other branch. See the [Code Contribution](https://docs.asterisk.org/Development/Policies-and-Procedures/Code-Contribution/) documentation for more information.
30+
31+
- [ ] The following `cherry-pick-to` values are invalid: . Valid values are .
32+
33+
- [ ] An Alembic change was detected but a commit message UpgradeNote with at least one of the 'alembic', 'database' or 'schema' keywords wasn't found. Please add an UpgradeNote to the commit message that mentions oneof those keywords notifying users that there's a database schema change.
34+
2235
- [ ] An Alembic change was detected but no changes were detected to any sample config file. If this PR changes the database schema, it probably should also include changes to the matching sample config files in configs/samples.
36+
2337
- [ ] There appear to be changes to Autoconf source files (configure.ac, bootstrap.sh, *.m4) but the ./configure file itself hasn't changed. If you change any Autoconf source file, you must run `./bootstrap.sh` to regenerate the configure file.
38+
2439
- [ ] The ./configure file appears to have been changed manually. This file is auto-generated by running `./bootstrap.sh` and must not be modified directly. Please revert the changes to the ./configure file and run `./bootstrap.sh` to regenerate it.
25-
- [ ] There appear to be changes to res/res_ari_*.c and/or res/ari/*.h files but no corresponding changes to the the json files in rest-api/api-docs. The *.c and *.h files are auto-generated from the json files by `make ari-stubs` and must not be modified directly.
40+
41+
- [ ] There appear to be changes to res/res_ari_*.c and/or res/ari/*.h files but no corresponding changes tothe the json files in rest-api/api-docs. The *.c and *.h files are auto-generated from the json files by `make ari-stubs` and must not be modified directly.
42+
2643
- [ ] There appear to be changes to the json files in rest-api/api-docs but no corresponding changes to the res/res_ari_*.c and/or res/ari/*.h files that are generated from them. You must run `make ari-stubs` after modifying any file in rest-api/api-docs and include the changes in your commit.
27-
- [ ] An ARI change was detected but a commit message UpgradeNote mentioning ARI wasn't found. Please add an UpgradeNote to the commit message that mentions ARI notifying users that there's been a change to the REST resources.
44+
45+
- [ ] An ARI change was detected but a commit message UpgradeNote or DeveloperNote mentioning ARI wasn't found. Please add a DeveloperNote for new capabilities or an UpgradeNote for non-backwards compatible changes tothe commit message that mentions ARI notifying users that there's been a change to the REST resources.
46+
2847
- [ ] A change was detected to the sample configuration files in ./config/samples but no UserNote or UpgradeNote was found in the commit message. If this PR includes changes that contain new configuration parameters or a change to existing parameters, please include a UserNote in the commit message. If the changes require some action from the user to preserve existing behavior, please include an UpgradeNote.
29-
- [ ] A change was detected to the pjsip sample configuration files in ./config/samples but no Alembic change was detected. If this PR includes changes that contain new configuration parameters or a change to existing configuration parameters for pjsip, chances are that a change to the realtime database schema is also required.
48+
49+
- [ ] A change was detected to the pjsip sample configuration files in ./config/samples but no Alembic change was detected. If this PR includes changes that contain new configuration parameters or a change to existingconfiguration parameters for pjsip, chances are that a change to the realtime database schema is also required.
3050

3151
Documentation:<br>
3252
* [Asterisk Developer Documentation](https://docs.asterisk.org/Development/)<br>

docs/Development/Policies-and-Procedures/image2023-4-17-1442.png renamed to docs/Development/Policies-and-Procedures/Code-Contribution/image2023-4-17-1442.png

File renamed without changes.

0 commit comments

Comments
 (0)