Skip to content

doc:update contributing md for internal developers #5250

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
merged 1 commit into from
Jun 18, 2025
+13 −0
Merged

doc:update contributing md for internal developers #5250

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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,18 @@ Developer workflow for code contributions is as follows:

The naming of the merge requests in TensorRT-LLM follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). If the PR includes an API change that might break user code/API usage, consider adding "BREAKING CHANGE" in the title so that reviewers know what to expect. Additionally, if the PR is not related to any bug and task, consider using "chore" or None as the placeholder.

[!IMPORTANT]
For NVIDIA developers, please include the JIRA number or NVBUG ID in the PR title whenever possible.

Good PR Titles Examples:
* feat: Add support for starcoder-v2 FP8 base + FP16/BF16 LoRA
* BREAKING CHANGE: Set default max batch size to 2048
* chore: Remove version from plugins .so
* None: Stringized enums for better error msgs
* fix https://github.com/NVIDIA/TensorRT-LLM/issues/700: a Memory leak issue in C++ runtime
* [TRTLLM-5516] perf: replicate dummy request for cuda graph padding (**NVIDIAN only**)
* [nvbug/5334370] fix: Fix one model EAGLE3 (**NVIDIAN only**)


This is important for tracking and collecting what has been submitted to which release and makes it easier for others to track the bugs or tasks. It could also be helpful when collecting GitHub publish announcement.

Expand All @@ -118,6 +124,13 @@ In the PR description, please consider addressing these points:
* Potential performance or functional impacts of the changes. If there are risks, please inform the reviewers.
* Link to the related PRs.

[!IMPORTANT]
For NVIDIA developers, please submit feature or bug fixes to the dedicated branch specified in the nvbug
**Keywords** field. For example, if a bug is reported on the release/v0.20 branch, please submit the fix to
`release/v0.20` instead of the main branch.

Meanwhile, please add the "release blocker" label to any PRs that could potentially cause a release delay.


## Tests and Code Review for Protected APIs

Expand Down