From 5300e6478acbd9365224808f3db00ba384bdaa96 Mon Sep 17 00:00:00 2001 From: Ryan Johnson Date: Sat, 11 Mar 2023 20:04:46 -0800 Subject: [PATCH] Replace yaml issue templates with markdown templates (#287) ## Description Replaces the issue forms with the old markdown issue templates. Some details have changed too. I've found the issue forms to be inflexible and the interface a bit clunky. We can switch back if the situation improves. --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 41 ---------------------- .github/ISSUE_TEMPLATE/feature_request.md | 24 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 22 ------------ .github/pull_request_template.md | 2 +- 5 files changed, 65 insertions(+), 64 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..71dd03b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug Report +about: Is something not working correctly? +title: '' +labels: bug, triage +assignees: '' +--- + +## Valence Version + +The commit hash or release number of the version you're using. + +## What You Did + +Describe how you arrived at the problem. If you can, provide a minimal reproducible example in the details below. + +
+ +Playground + +```rust +PASTE YOUR PLAYGROUND CODE HERE +``` + +
+ +## What Went Wrong + +What were you expecting and what actually happened? + +## Additional Information + +Other information that can be used to further reproduce or isolate the problem. +This commonly includes: + +- theories about what might be going wrong +- links to related bugs, PRs or discussions +- workarounds that you used +- screenshots +- logs diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 2fc4b91..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: Report a Bug -description: Is there something not working like you expected? Let us know! -labels: [bug, triage] -body: - - type: input - attributes: - label: Valence Version - description: What version of Valence are you using? If you are targeting a specific commit or branch, put that instead. - placeholder: Version, branch, or commit hash. - validations: - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. Include any screenshots or additional information here. - validations: - required: false - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: true - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. Create a server using my sample - 2. Do this... - 3. Do that... - 4. See error - validations: - required: true - - type: textarea - attributes: - label: Minimal Reproducible Example - description: A minimal example that exhibits the behavior. If you have a playground, paste it here. If the problem can be reproduced with one of the examples, just indicate which one instead. - render: Rust - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2efeff0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature Request +about: Do you have an idea for a new feature? +title: '' +labels: enhancement +assignees: '' +--- + +## Describe the problem related to your feature request. + +A description of what the problem is. + +## What solution would you like? + +The solution you propose for the problem presented. + +## What alternative(s) have you considered? + +Other solutions to solve and/or work around the problem presented. + +## Additional context + +Any other information you would like to add such as related previous work, +screenshots, benchmarks, etc. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 0d7cbf5..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Feature Request -description: Do you have an idea for a new feature? Let us know! -labels: [enhancement] -body: - - type: textarea - attributes: - label: Describe the problem related to your feature request. - description: A clear description of what the problem is. - validations: - required: true - - type: textarea - attributes: - label: Describe the solution you would like. - description: The solution you propose for the problem presented. - validations: - required: true - - type: textarea - attributes: - label: Additional context - description: Add any other context or screenshots about the feature request here. - validations: - required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f9e8e58..f6c18d6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ ## Description -Describe the changes you've made. Link to any issues that this PR fixes or addresses. +Describe the changes you've made. Link to any issues this PR fixes or addresses. ## Test Plan