From 7b9ab90bc02fb95b930cb1aa5e68cc9d44c69af5 Mon Sep 17 00:00:00 2001 From: Jordan GAZEAU Date: Tue, 2 Aug 2022 23:11:26 +0200 Subject: [PATCH] chore: add github templates --- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature.yml | 17 +++++++++ .github/ISSUE_TEMPLATE/issue.yml | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 12 ++++++ .../pull_request_template.md | 14 +++++++ 5 files changed, 82 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/ISSUE_TEMPLATE/issue.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..2e1556e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,17 @@ +name: Feature +description: Request a new feature +title: "[feature_request]: " +labels: ["enhancement"] +body: + - type: textarea + id: request + attributes: + label: What is missing in the project? + description: Please provide what is missing in the project and why it should be added? + validations: + required: true + - type: textarea + id: solution + attributes: + label: Solution? + description: Got a solution, or an idea to implement the feature? Feel free to provide it! diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml new file mode 100644 index 0000000..b696595 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -0,0 +1,38 @@ +name: Bug Report +description: Create a bug report +title: "[bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + # What is the issue? + --- + *Please provide as much information as you can in this bug report!* + *Also remember to provide a reproducer if possible, it will make it easier and quicker to help you 😉* + - type: textarea + id: issue-steps + attributes: + label: Steps that lead to the issue + description: Please provide all the steps and relevant information that lead to your issue (logs, screenshots, versions, ...). + validations: + required: true + - type: textarea + id: issue-expected-behavior + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: issue-reproducer + attributes: + label: Reproducer + description: Provide a reproducer so we can easily and quickly help you. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Solution? + description: Got a solution, or an idea to solve the issue? Feel free to provide it! diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..6ad0fd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,12 @@ +name: Question +description: Ask a question related to the project +title: "[question]: " +labels: ["question"] +body: + - type: textarea + id: question + attributes: + label: Question? + description: Feel free to ask any question regarding the project. + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..6f65a24 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,14 @@ +# Description + +Please provide a summary of the change, including context of this PR and link to the appropriate issue(s) if any. + +Fixes # + +# PR checklist: + +- [ ] Code follows the code style schemes of the project +- [ ] Code is tested +- [ ] Code quality is at least even, ideally greater +- [ ] Code commits are following the [Conventional Commits](https://www.conventionalcommits.org/) specification +- [ ] Documentation is up-to-date (code comments, project documentation, ...) +- [ ] All tests passed successfully \ No newline at end of file