-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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.
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
docs: Simplify PR templates #7753
base: main
Are you sure you want to change the base?
Changes from all commits
c329f48
d496f95
d191ef9
0b63e0d
ebd6a3e
6ca4764
57b49b4
b0bbabb
8f5f515
5b46d0e
e2e3837
a4b8162
06df7a8
45278d7
cb0c2e5
14f70b6
6bc5625
fb3747a
1ea633a
b48aa57
8af13e9
b5f1f7d
310c38c
fa72cf2
2782d30
cf5fe35
c205451
4a719e4
87165b2
7b06a37
b6e017e
3e79b2a
7edeb9f
3bff367
bc71da0
6192c6e
a514a05
28f497c
ddfdb2a
56e4232
d98a59c
2309bce
d0e2653
f92732d
776e641
b0a495a
508929a
738c98f
3d79568
1df73dc
4294cc6
f078bfb
80fc56c
8a2a229
59e267f
21a7fc5
60872b9
8d8b607
adafa4f
551978b
246f46c
1dcf2cf
9be77f1
19b02a2
d0f332b
c2299d5
110251b
25266a5
b012bd0
52a1cd2
b2e6e7e
9786e40
e92abf2
8139431
5c6e487
9f16eef
8b36aa8
afaa6f4
fdbfb27
2be127b
df753d7
a844eda
8a208d7
1dfa33d
879a505
e9e3648
dbeb198
e1d58c7
74660f1
2150fc2
cbd6967
aff4b93
10f1c8d
5e20ef6
52f97b5
159b060
196caf0
5b739db
0a4c87b
3b6c6f9
b889687
7529f0e
e116a2a
8e88f2c
e965287
233c4b2
2de09ee
dba31c2
09b34be
1da454c
f243276
365b86a
987deaa
d432266
5239ff0
16e5470
3c99c95
a9d3dac
ee6d238
c724193
27c2142
884ca4e
6694b74
dd71d3b
a669145
4dcda7f
d6fe6e6
d356d6e
747f5d4
0370485
3e97828
9faf444
620f095
0c4228c
1322225
2d2c0b5
9cfc53a
60a06bf
729b677
ea095c9
20f3487
c907231
c3eb5ca
13f819b
d189a87
4d113dc
6a303f8
34390d7
b0ea306
b6734dd
31f00b6
497475e
8ce3890
8745160
03ca720
c0e4c81
7236796
3135eb5
fe63eba
5f8497f
fd1d9c4
f326993
9e55dab
0f4c9d3
686cf1a
33d7e7e
65a9140
4415430
8c5b94c
66e4fff
e9b811c
dabb7cb
2f299d1
22d9261
b263bfc
3421429
96ef8a7
f151f8a
b8a3629
5e61a01
e713208
3443dd6
839faf7
d4b585d
327ee02
5b33a25
04e0d85
3c7263f
ea3ebca
a5ad309
61466d4
cadd112
5611ca1
6857dc3
c91d1e5
a7a43a2
3735d99
8e56e30
be1a0a5
ef6afcd
c88aec5
3ea493f
01438d8
5104900
89a9038
cb1204d
8da14cc
9076d2c
3eab666
e452b58
a93de16
b4525aa
e44cf29
fe0e41e
c2fa60c
26a05ed
b0adf31
86dbef3
1fa799e
3a21f61
1df30ed
9bbee48
71a285a
d6488fd
fb430c7
d13235c
466fed4
f9ca1b8
c730982
0200d2c
1a54d83
2961cf8
01e77a8
aeb20a1
dedb9e7
940aa22
6f6cbe0
aa93b95
ee198de
12b1968
10d7eaa
2f8de73
dcfc6a0
128f19a
678fabd
9695d15
e3f7eac
a4b7f29
3e75a93
dd41b92
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Description** | ||
A clear and concise description of what the bug is. | ||
|
||
**Triton Information** | ||
What version of Triton are you using? | ||
|
||
Are you using the Triton container or did you build it yourself? | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior. | ||
|
||
Describe the models (framework, inputs, outputs), ideally include the model configuration file (if using an ensemble include the model configuration file for that as well). | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
#### What does the PR do? | ||
<!-- Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.--> | ||
|
||
#### Checklist | ||
- [ ] I have read the [Contribution guidelines](#../../CONTRIBUTING.md) and signed the [Contributor License | ||
Agreement](https://github.com/NVIDIA/triton-inference-server/blob/master/Triton-CCLA-v1.pdf). | ||
- [ ] PR title reflects the change and is of format `<commit_type>: <Title>`. Check the [conventional commit type](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type). | ||
- [ ] Changes are described in the pull request. | ||
- [ ] Related issues are referenced. | ||
- [ ] Populated [github labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) field. | ||
- [ ] Added [test plan](#test-plan) and verified test passes. | ||
- [ ] Verified that the PR passes existing CI. | ||
- [ ] I ran pre-commit locally (`pre-commit install, pre-commit run --all`). | ||
- [ ] Verified copyright is correct on all changed files. | ||
- [ ] Added _succinct_ git squash message before merging [ref](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
- [ ] All template sections are filled out. | ||
- [ ] Optional: Additional screenshots for behavior/output changes with before/after. | ||
|
||
#### Related PRs: | ||
<!-- Related PRs from other Repositories --> | ||
|
||
#### Where should the reviewer start? | ||
<!-- call out specific files that should be looked at closely --> | ||
|
||
#### Test plan: | ||
<!-- list steps to verify feature works --> | ||
<!-- were e2e tests added?--> | ||
|
||
#### Caveats: | ||
<!-- any limitations or possible things missing from this PR --> | ||
|
||
#### Background | ||
<!-- e.g. what led to this change being made. this is optional extra information to help the reviewer --> | ||
|
||
#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) | ||
- closes GitHub issue: #xxx |
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,33 @@ | ||||||||
#### What does the PR do? | ||||||||
<!-- Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.--> | ||||||||
|
||||||||
#### Checklist | ||||||||
- [ ] PR title reflects the change and is of format `<commit_type>: <Title>`. Check the [conventional commit type](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type). | ||||||||
- [ ] Changes are described in the pull request. | ||||||||
- [ ] Populated [github labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) field. | ||||||||
- [ ] Added [test plan](#test-plan) and verified test passes. | ||||||||
- [ ] Verified that the PR passes existing CI. | ||||||||
- [ ] Verified copyright is correct on all changed files. | ||||||||
- [ ] Added _succinct_ git squash message before merging [ref](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||||||||
- [ ] All template sections are filled out. | ||||||||
- [ ] Optional: Related issues are referenced. | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think this should be optional. It's useful for cherry picks to know of related PRs, and if the PR closes an issue, we should mark it as closed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's optional because most PRs do not related to a GitHub issue. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. when I created this PR, I conflated the word "issue". I agree that only sometimes the PR is related to a Github issue. Can you add a checkbox that says:
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is already a "Related PRs" section. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think "related issue" should be a dedicated section, GitHub should be able to link and close the issue automatically if the specified format is followed: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword |
||||||||
- [ ] Optional: Additional screenshots for behavior/output changes with before/after. | ||||||||
|
||||||||
#### Related PRs: | ||||||||
<!-- Related PRs from other Repositories --> | ||||||||
|
||||||||
#### Where should the reviewer start? | ||||||||
<!-- call out specific files that should be looked at closely --> | ||||||||
|
||||||||
#### Test plan: | ||||||||
<!-- list steps to verify --> | ||||||||
<!-- were e2e tests added?--> | ||||||||
|
||||||||
#### Caveats: | ||||||||
<!-- any limitations or possible things missing from this PR --> | ||||||||
|
||||||||
#### Background | ||||||||
<!-- e.g. what led to this change being made. this is optional extra information to help the reviewer --> | ||||||||
|
||||||||
#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) | ||||||||
- closes GitHub issue: #xxx |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Thanks for submitting a PR to Triton! | ||
Please go the the `Preview` tab above this description box and select the appropriate sub-template: | ||
|
||
* [PR description template for Triton Engineers](?expand=1&template=pull_request_template_internal_contrib.md) | ||
* [PR description template for External Contributors](?expand=1&template=pull_request_template_external_contrib.md) | ||
|
||
If you already created the PR, please replace this message with one of | ||
* [External contribution template](https://raw.githubusercontent.com/triton-inference-server/server/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template_external_contrib.md) | ||
* [Internal contribution template](https://raw.githubusercontent.com/triton-inference-server/server/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template_internal_contrib.md) | ||
|
||
and fill it out. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Copyright 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
# | ||
# Redistribution and use in source and binary forms, with or without | ||
# modification, are permitted provided that the following conditions | ||
# are met: | ||
# * Redistributions of source code must retain the above copyright | ||
# notice, this list of conditions and the following disclaimer. | ||
# * Redistributions in binary form must reproduce the above copyright | ||
# notice, this list of conditions and the following disclaimer in the | ||
# documentation and/or other materials provided with the distribution. | ||
# * Neither the name of NVIDIA CORPORATION nor the names of its | ||
# contributors may be used to endorse or promote products derived | ||
# from this software without specific prior written permission. | ||
# | ||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY | ||
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | ||
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
||
name: "CodeQL" | ||
|
||
on: | ||
pull_request: | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze | ||
runs-on: ubuntu-latest | ||
permissions: | ||
actions: read | ||
contents: read | ||
security-events: write | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
language: [ 'python' ] | ||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] | ||
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
# Initializes the CodeQL tools for scanning. | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v2 | ||
with: | ||
languages: ${{ matrix.language }} | ||
# If you wish to specify custom queries, you can do so here or in a config file. | ||
# By default, queries listed here will override any specified in a config file. | ||
# Prefix the list here with "+" to use these queries and those in the config file. | ||
|
||
# Details on CodeQL's query packs refer to: | ||
# https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs | ||
queries: +security-and-quality | ||
|
||
|
||
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java). | ||
# If this step fails, then you should remove it and run the build manually (see below) | ||
- name: Autobuild | ||
uses: github/codeql-action/autobuild@v2 | ||
|
||
# Command-line programs to run using the OS shell. | ||
# See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||
|
||
# If the Autobuild fails above, remove it and uncomment the following three lines. | ||
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. | ||
|
||
# - run: | | ||
# echo "Run, Build Application using script" | ||
# ./location_of_script_within_repo/buildscript.sh | ||
|
||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v2 | ||
with: | ||
category: "/language:${{matrix.language}}" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Copyright 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
# | ||
# Redistribution and use in source and binary forms, with or without | ||
# modification, are permitted provided that the following conditions | ||
# are met: | ||
# * Redistributions of source code must retain the above copyright | ||
# notice, this list of conditions and the following disclaimer. | ||
# * Redistributions in binary form must reproduce the above copyright | ||
# notice, this list of conditions and the following disclaimer in the | ||
# documentation and/or other materials provided with the distribution. | ||
# * Neither the name of NVIDIA CORPORATION nor the names of its | ||
# contributors may be used to endorse or promote products derived | ||
# from this software without specific prior written permission. | ||
# | ||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY | ||
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | ||
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
||
name: pre-commit | ||
|
||
on: | ||
pull_request: | ||
|
||
jobs: | ||
pre-commit: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 2 | ||
- name: Get modified files | ||
id: modified-files | ||
run: echo "modified_files=$(git diff --name-only -r HEAD^1 HEAD | xargs)" >> $GITHUB_OUTPUT | ||
- uses: actions/setup-python@v3 | ||
- uses: pre-commit/[email protected] | ||
with: | ||
extra_args: --files ${{ steps.modified-files.outputs.modified_files }} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,17 @@ | ||
/bazel-bin | ||
/bazel-ci_build-cache | ||
/bazel-genfiles | ||
/bazel-trtserver | ||
/bazel-out | ||
/bazel-serving | ||
/bazel-tensorflow | ||
/bazel-tensorflow_serving | ||
/bazel-testlogs | ||
/bazel-tf | ||
/bazel-workspace | ||
/build | ||
/builddir | ||
/.vscode | ||
*.so | ||
__pycache__ | ||
tmp | ||
*.log | ||
*.xml | ||
test_results.txt | ||
artifacts | ||
cprofile | ||
*.prof | ||
|
||
# Test exclusions | ||
qa/L0_openai/openai | ||
tensorrtllm_models | ||
custom_tokenizer |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Copyright 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
# | ||
# Redistribution and use in source and binary forms, with or without | ||
# modification, are permitted provided that the following conditions | ||
# are met: | ||
# * Redistributions of source code must retain the above copyright | ||
# notice, this list of conditions and the following disclaimer. | ||
# * Redistributions in binary form must reproduce the above copyright | ||
# notice, this list of conditions and the following disclaimer in the | ||
# documentation and/or other materials provided with the distribution. | ||
# * Neither the name of NVIDIA CORPORATION nor the names of its | ||
# contributors may be used to endorse or promote products derived | ||
# from this software without specific prior written permission. | ||
# | ||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY | ||
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | ||
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
||
repos: | ||
- repo: https://github.com/timothycrosley/isort | ||
rev: 5.12.0 | ||
hooks: | ||
- id: isort | ||
additional_dependencies: [toml] | ||
- repo: https://github.com/psf/black | ||
rev: 23.1.0 | ||
hooks: | ||
- id: black | ||
types_or: [python, cython] | ||
- repo: https://github.com/PyCQA/flake8 | ||
rev: 5.0.4 | ||
hooks: | ||
- id: flake8 | ||
args: [--max-line-length=88, --select=C,E,F,W,B,B950, --extend-ignore = E203,E501] | ||
types_or: [python, cython] | ||
- repo: https://github.com/pre-commit/mirrors-clang-format | ||
rev: v16.0.5 | ||
hooks: | ||
- id: clang-format | ||
types_or: [c, c++, cuda, proto, textproto, java] | ||
args: ["-fallback-style=none", "-style=file", "-i"] | ||
- repo: https://github.com/codespell-project/codespell | ||
rev: v2.2.4 | ||
hooks: | ||
- id: codespell | ||
additional_dependencies: [tomli] | ||
args: ["--toml", "pyproject.toml"] | ||
exclude: (?x)^(.*stemmer.*|.*stop_words.*|^CHANGELOG.md$) | ||
# More details about these pre-commit hooks here: | ||
# https://pre-commit.com/hooks.html | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.4.0 | ||
hooks: | ||
- id: check-case-conflict | ||
- id: check-executables-have-shebangs | ||
- id: check-merge-conflict | ||
- id: check-json | ||
- id: check-toml | ||
- id: check-yaml | ||
exclude: ^deploy(\/[^\/]+)*\/templates\/.*$ | ||
- id: check-shebang-scripts-are-executable | ||
- id: end-of-file-fixer | ||
types_or: [c, c++, cuda, proto, textproto, java, python] | ||
- id: mixed-line-ending | ||
- id: requirements-txt-fixer | ||
- id: trailing-whitespace | ||
|
||
- repo: local | ||
hooks: | ||
- id: add-license | ||
name: Add License | ||
entry: python tools/add_copyright.py | ||
language: python | ||
stages: [pre-commit] | ||
verbose: true | ||
require_serial: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would want to have a list of commonly used types ("i.e. feat, fix, doc") and mention that the link points to more types.