From f18a8ebd3bf6deac04c409b73d54e80fb8a32b5f Mon Sep 17 00:00:00 2001 From: Eric Shi Date: Wed, 22 Jan 2025 15:01:47 -0800 Subject: [PATCH] Update GitHub Issue and PR templates --- .github/ISSUE_TEMPLATE/2-feature-request.md | 4 ++-- .github/ISSUE_TEMPLATE/3-question.md | 2 +- .github/ISSUE_TEMPLATE/4-documentation.md | 6 +++--- .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++++++----------- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md index a7e4a4af0..c8ecd9050 100644 --- a/.github/ISSUE_TEMPLATE/2-feature-request.md +++ b/.github/ISSUE_TEMPLATE/2-feature-request.md @@ -1,8 +1,8 @@ --- name: Feature request about: Suggest an idea for this project. -title: "[REQUEST] " -labels: enhancement +title: "[REQ] " +labels: feature request assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/3-question.md b/.github/ISSUE_TEMPLATE/3-question.md index 72f7889e1..aa8e5d506 100644 --- a/.github/ISSUE_TEMPLATE/3-question.md +++ b/.github/ISSUE_TEMPLATE/3-question.md @@ -1,7 +1,7 @@ --- name: Question about: Ask a question about Warp. -title: "[QUESTION] <title>" +title: "[QUESTION] " labels: question assignees: '' diff --git a/.github/ISSUE_TEMPLATE/4-documentation.md b/.github/ISSUE_TEMPLATE/4-documentation.md index 85202d418..631305c9d 100644 --- a/.github/ISSUE_TEMPLATE/4-documentation.md +++ b/.github/ISSUE_TEMPLATE/4-documentation.md @@ -1,8 +1,8 @@ --- name: Documentation request about: Suggest improvements for the documentation. -title: "[DOCS] <title>" -labels: documentation +title: "[DOCS] " +labels: docs assignees: '' --- @@ -14,7 +14,7 @@ Please check all applicable options from the list below (use [x] in Markdown) - [ ] Report an error in the documentation. - [ ] Request for something to be documented. -- [ ] Request for a new [example](https://github.com/NVIDIA/warp/tree/main/warp/examples) to illustrate how to do something. +- [ ] Suggestion to improve the documentation. - [ ] Other (please explain) ## Description diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d3d0dd7c0..7ee51821d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,11 @@ <!-- -Thank you for contributing to NVIDIA Warp! If you haven't yet, -please read the contributing guidelines in the CONTRIBUTING.md file. +Thank you for contributing to NVIDIA Warp! -Please fill the relevant sections in this PR template. +See the contribution guide: https://nvidia.github.io/warp/modules/contribution_guide.html -Fields in the Checklist section can be marked after you create and save the Pull Request. +Please fill the relevant sections. + +Checkboxes can also be marked after you submit the PR. --> ## Category @@ -27,15 +28,14 @@ Include any limitations or non-handled areas in the changes. --> ## Changelog -<!--The list in this section will be used creating the changelog for the next release. --> +<!--This will help inform the creation of the changelog for the next release.--> -- Add specific line-by-line info of high level changes in this PR. +- Add specific line-by-line info of user-facing changes in this PR. ## Before your PR is "Ready for review" -- [ ] Do you agree to the terms under which contributions are accepted as described in Section 9 the Warp [License](https://github.com/NVIDIA/warp/blob/main/LICENSE.md)? -- [ ] Have you read the [Contributor Guidelines](https://github.com/NVIDIA/warp/blob/main/CONTRIBUTING.md)? -- [ ] Have you written any new necessary tests? -- [ ] Have you added or updated any necessary documentation? -- [ ] Have you added any files modified by compiling Warp and building the documentation to this PR (.e.g. `stubs.py`, `functions.rst`)? -- [ ] Does your code pass `ruff check` and `ruff format --check`? +- [ ] Do you agree to the terms under which contributions are accepted as described in Section 9 the [Warp License](https://github.com/NVIDIA/warp/blob/main/LICENSE.md)? +- [ ] Necessary tests have been added +- [ ] Documentation is up-to-date +- [ ] Auto-generated files modified by compiling Warp and building the documentation have been updated (e.g. `stubs.py`, `functions.rst`) +- [ ] Code passes `ruff check` and `ruff format --check`?