From d34792311dc1f7503debc56dbadf2ef2fe641061 Mon Sep 17 00:00:00 2001 From: James Cobb Date: Tue, 12 Oct 2021 18:42:20 -0500 Subject: [PATCH] add issue templates and update linting --- .github/ISSUE_TEMPLATE/bug_report.md | 51 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++ .github/ISSUE_TEMPLATE/general_question.md | 11 +++++ .github/pull_request_template.md | 3 -- .github/workflows/lint.yml | 2 +- 6 files changed, 81 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/general_question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..1a05333 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,51 @@ +name: Bug Report +description: File a bug report +title: '[BUG] ' +body: + - type: textarea + attributes: + label: Bug Description + description: >- + What is the bug? Please provide a snippet of output including + any errors and the messages logged before the error. + Verbose or debug logs are preferred but please ensure all secrets and + other sensitive information has been removed. + placeholder: I did ... and ... happened. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: | + What did you expect to happen? For example, expected output or behavior. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: >- + Please provide the steps that can be used to reproduce this behavior. + + If possible, please include an example project (GitHub repository) that + is capable of reproducing this behavior. + The example project should only include the minimum required code + to reproduce the issue. + It should not depend on any external resource. + value: | + Example project: ... + + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a49eab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d18e0f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[REQUEST] feature" +--- + +**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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general_question.md b/.github/ISSUE_TEMPLATE/general_question.md new file mode 100644 index 0000000..8acd361 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_question.md @@ -0,0 +1,11 @@ +--- +name: General Question +about: General question about the project, usage, design, etc. +title: "[QUESTION]" +--- + +**Question** +Your question here. + +**Context** +Any additional context around the question such a link to a project where it's being implemented. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 12a9bb0..a5920be 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -37,11 +37,8 @@ # Checklist <!-- You can erase any parts of this template not applicable to your Pull Request. --> -- [ ] Have you followed the guidelines in our Contributing document? - [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? - [ ] Does your submission pass tests? - [ ] Have you linted your code locally prior to submission? - [ ] Have you added an explanation of what your changes do and why you'd like us to include them? -- [ ] Have you written new tests for your core changes, as applicable? -- [ ] Have you successfully ran tests with your changes locally? - [ ] Have you updated documentation, as applicable? \ No newline at end of file diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 1a7b9cf..5d6b937 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -16,7 +16,7 @@ name: Lint Code Base ############################# on: push: - branches-ignore: [beta, main] + branches-ignore: [beta, master] # Remove the line above to run when pushing to master ###############