Skip to content

Code Contribution: Add instructions for patching the third-party libs. #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtjoseph merged 1 commit into from
Aug 11, 2026
Merged

Code Contribution: Add instructions for patching the third-party libs. #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/Development/Policies-and-Procedures/Code-Contribution/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

All code management/contribution/review processes will be handled with [GitHub Asterisk Pull Requests](https://github.com/asterisk/asterisk/pulls) and [GitHub Testsuite Pull Requests](https://github.com/asterisk/testsuite/pulls). Note that Asterisk and Testsuite pull requests must be created in their own repositories.

/// warning | Changes to the bundled pjproject, jansson or libjwt libraries

To prevent divergence from the upstream repositories, we do not fork them. Instead, we download their official release tarballs and apply patches which fall into one of two categories:

* Patches to set specific compile configuration or build options. These are rare.
* Patches to temporarily fix issues or add functionality that will be addressed in a future upstream release.

Therefore:

* Unless your proposed change falls into the first category, the change MUST be submitted to the upstream project and you must state in the PR comments that you have done so with a link to the upstream pull request.
* The patch file included in your Asterisk change must be created with `git format-patch` so it contains the upstream commit's full message. This allows us to trace back to the source commit in the future.
* When your upstream PR is merged, you must run `git format-patch` again on the merged commit and update the Asterisk PR with the new patch file.
* Your Asterisk PR will NOT be merged until the upstream PR is and you've stated that it is in the Asterisk PR comments.

///

## Code Contribution Process

### AI Policy
Expand Down Expand Up @@ -76,6 +92,7 @@ You MUST not create entries in the doc/CHANGES-staging or doc/UPGRADE-staging di

### Commit


Commit messages should follow the guidelines established in [Commit Messages](/Development/Policies-and-Procedures/Commit-Messages).

Sample Commit Message
Expand Down