-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #593 from lgleim/github-templates
[Feature] Introduce templates to encourage useful issues and pull request
- Loading branch information
Showing
9 changed files
with
216 additions
and
8 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| name: "🐛 Bug report" | ||
| description: Report errors or unexpected behavior | ||
| title: "[Bug]: " | ||
| labels: ["bug", "triage-needed"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/Genesis-Embodied-AI/Genesis/issues) before filing a new one! | ||
| - type: textarea | ||
| id: bug-description | ||
| attributes: | ||
| label: Bug Description | ||
| placeholder: | | ||
| A clear and concise description of what the bug is. | ||
| Try to isolate the issue to help the community to reproduce it easily and increase chances for a fast fix. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| placeholder: | | ||
| If possible, provide a script triggering the bug, e.g. | ||
| ```python | ||
| # code snippet triggering the bug | ||
| import genesis as gs | ||
| gs.init() | ||
| scene = gs.Scene(show_viewer=False) | ||
| broken = scene.add_entity( | ||
| gs.morphs.MJCF(file='attachement.xml'), | ||
| ) | ||
| scene.build() | ||
| ``` | ||
| Make sure to attached any needed assets (here `attachement.xml`)! | ||
| value: | | ||
| If possible, provide a script triggering the bug, e.g. | ||
| ```python | ||
| # code snippet triggering the bug | ||
| import genesis as gs | ||
| gs.init() | ||
| scene = gs.Scene(show_viewer=False) | ||
| broken = scene.add_entity( | ||
| gs.morphs.MJCF(file='attachement.xml'), | ||
| ) | ||
| scene.build() | ||
| ``` | ||
| Make sure to attached any needed assets (here `attachement.xml`)! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
| placeholder: "A clear and concise description of what you expected to happen." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: screenshots-videos | ||
| attributes: | ||
| label: Screenshots/Videos | ||
| placeholder: "If applicable, add screenshots and/or a video to help explain your problem." | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| placeholder: | | ||
| Please copy and paste any relevant console output. | ||
| This will be automatically formatted into code, so no need for backticks. | ||
| render: shell | ||
| - type: textarea | ||
| id: desktop-device | ||
| attributes: | ||
| label: Environment | ||
| placeholder: | | ||
| - OS: [e.g. Ubuntu 24.04, Windows 11 24H2] | ||
| - GPU/CPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x] (N/A if no GPU/CPU) | ||
| - GPU-driver version (N/A if no GPU) | ||
| - CUDA / CUDA-toolkit version (N/A if non-Nvidia) | ||
| value: | | ||
| - OS: [e.g. Ubuntu 24.04, Windows 11 24H2] | ||
| - GPU/CPU [e.g. A100, RTX 4090, M3pr, Intel I9-9900k, Ryzen 5900x] (N/A if no GPU/CPU) | ||
| - GPU-driver version (N/A if no GPU) | ||
| - CUDA / CUDA-toolkit version (N/A if non-Nvidia) | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: version | ||
| attributes: | ||
| label: Release version or Commit ID | ||
| placeholder: | | ||
| Please provide: | ||
| - a) **version numer** of the release causing the issue, OR | ||
| - b) **SHA/hash** of the latest commit if working from git. You can get this by running the `git rev-parse HEAD` command on your current branch. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional Context | ||
| placeholder: "Add any other context about the problem here." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| name: "🚀 Feature Request" | ||
| description: Sugest a new feature request or improvement on the project | ||
| title: '[Feature]: ' | ||
| labels: | ||
| - feature | ||
| - enhancement | ||
| - triage-needed | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Please providee a well-structured and concise breakdown of context, expected outcomes, and potential of the feature you are proposing. | ||
| - type: textarea | ||
| id: suggestion | ||
| attributes: | ||
| label: What feature or enhancement are you proposing? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: Motivation | ||
| description: What is your motivation for adding / enhancing this feature, optimally described in the form of a concrete user story or use case. | ||
| value: | | ||
| <!-- Motivation for adding / enhancing this feature, optimally describing a concrete use case in the form of a user story --> | ||
| As a [e.g. civil engineering researcher working on flood simulation] | ||
| I want to [e.g. be able to simulate city-scale fluid / terrain simulations] | ||
| Because [e.g. this enables the efficient design and validation of flood protection structures]. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: benefits | ||
| attributes: | ||
| label: Potential Benefit | ||
| placeholder: Describe the potential benefit of implementing this feature / enhancement | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: acceptcriterea | ||
| attributes: | ||
| label: What is the expected outcome of the implementation work? | ||
| description: List the acceptance criteria for this task in a form of a list. | ||
| value: '- [ ]' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additionalinfo | ||
| attributes: | ||
| label: Additional information | ||
| description: If you think that any additional information would be useful please provide them here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: "💬 Support & Questions - Github Community Support" | ||
| url: https://github.com/Genesis-Embodied-AI/Genesis/discussions | ||
| about: Please ask and answer questions here. | ||
| - name: "⚠️ Documentation Issues" | ||
| url: https://github.com/Genesis-Embodied-AI/genesis-doc/issues | ||
| about: Please report issues in our documentation here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <!-- Thanks for sending a pull request! Please: | ||
| 1. Follow our contributor guidelines: | ||
| https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md | ||
| 2. Prepare your PR according to the "Submitting Code Changes" | ||
| section of https://github.com/Genesis-Embodied-AI/Genesis/blob/main/.github/CONTRIBUTING.md | ||
| 3. Provide a concise summary of your changes in the Title above | ||
| 4. Prefix the title according to the type of issue you are addressing. Use: | ||
| - [BUG FIX] for non-breaking changes which fix an issue | ||
| - [FEATURE] for non-breaking changes which add functionality | ||
| - [MISC] for minor changes such as improved inline documentation or fixing typos | ||
| - [BREAKING] **in addition to the above** for breaking changes, i.e., a fix or feature that would cause existing APIs or functionality to change | ||
| --> | ||
|
|
||
| ## Description | ||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ## Related Issue | ||
| <!--- This project only accepts pull requests related to open issues. | ||
| If suggesting a new feature or change, please discuss it in an issue first. | ||
| If fixing a bug, there should be an issue describing it with steps to reproduce. | ||
| Please link to the relevant issue here, e.g. via `Resolves <issue-url>`. | ||
| Cf. https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue --> | ||
|
|
||
| Resolves Genesis-Embodied-AI/Genesis#<your-issue-number> | ||
|
|
||
| ## Motivation and Context | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
|
|
||
| ## How Has This Been / Can This Be Tested? | ||
| <!--- Please describe in detail how you tested your changes. | ||
| Include details of your testing environment, and the tests you ran to | ||
| see how your change affects other areas of the code, etc. --> | ||
|
|
||
| ## Screenshots (if appropriate): | ||
|
|
||
| ## Checklist: | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| - [ ] I read the **CONTRIBUTING** document. | ||
| - [ ] I followed the `Submitting Code Changes` section of **CONTRIBUTING** document. | ||
| - [ ] I tagged the title correctly (including BUG FIX/FEATURE/MISC/BREAKING) | ||
| - [ ] I updated the [documentation](https://github.com/Genesis-Embodied-AI/genesis-doc) accordingly or no change is needed. | ||
| - [ ] I tested my changes and added instructions on how to test it for reviewers. | ||
|
|
||
| <!--- Optionally --> | ||
| - [ ] I have added tests to cover my changes. | ||
| - [ ] All new and existing tests passed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters