Skip to content

Commit

Permalink
Merge branch 'ershi/github-templates' into 'main'
Browse files Browse the repository at this point in the history
Add GitHub issue and pull request templates

See merge request omniverse/warp!534
  • Loading branch information
shi-eric committed Jun 6, 2024
2 parents 6bd0b84 + 109a00f commit d52bf7a
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Bug Report
description: Create a report to help us improve Warp.
title: "[BUG] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
attributes:
label: Bug Description
description: >-
Describe the bug and how to reproduce it. Self-contained code samples are welcome!
validations:
required: true
- type: textarea
attributes:
label: System Information
description: >-
Provide some details about your environment, such as the Warp version, Python version, and OS.
placeholder: (Optional)
validations:
required: false
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Suggest an idea for this project.
title: "[REQUEST] <title>"
labels: enhancement
assignees: ''

---

### Description
<!-- Describe your request. -->

### Context
<!-- What is the motivation for this request? -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/3-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question
about: Ask a question about Warp.
title: "[QUESTION] <title>"
labels: question
assignees: ''

---

<!-- Ask a question about Warp. -->
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/4-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Documentation request
about: Suggest improvements for the documentation.
title: "[DOCS] <title>"
labels: documentation
assignees: ''

---

## Category
<!--
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.
- [ ] Other (please explain)

## Description
<!--
Please explain the request. Include links to any relevant files or webpages.
-->
41 changes: 41 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!--
Thank you for contributing to NVIDIA Warp! If you haven't yet,
please read the contributing guidelines in the CONTRIBUTING.md file.
Please fill the relevant sections in this PR template.
Fields in the Checklist section can be marked after you create and save the Pull Request.
-->

## Category
<!--
Please check all applicable options from the list below (use [x] in Markdown)
-->

- [ ] New feature
- [ ] Bugfix
- [ ] Breaking change
- [ ] Refactoring
- [ ] Documentation
- [ ] Other (please explain)

## Description
<!--
Please add a description of what this PR aims to accomplish.
Existing issues may be reference using a special keyword, e.g. Closes #10
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. -->

- Add specific line-by-line info of high level 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`?
File renamed without changes.

0 comments on commit d52bf7a

Please sign in to comment.