From 5094d3cbdec9ab3ccc1e710feb3363c40c1b85e5 Mon Sep 17 00:00:00 2001 From: Nguyen Long Nhat <27698189+torn4dom4n@users.noreply.github.com> Date: Thu, 6 Oct 2022 23:59:20 +0700 Subject: [PATCH] improve issue and PR templates --- .github/ISSUE_TEMPLATE/bug.yaml | 60 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.yaml | 32 ++++++++++++++ .github/ISSUE_TEMPLATE/urlchecker.yml | 32 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++---- 4 files changed, 137 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml create mode 100644 .github/ISSUE_TEMPLATE/urlchecker.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 000000000..756bbdef5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,60 @@ +name: "Bug Report" +description: "Submit a bug report to help us improve" +title: "Bug Report: " +labels: [🐛 BUG] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out our bug report form. + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "Steps to reproduce" + description: "Please walk us through it step by step." + placeholder: "First I ..." + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "Expected behavior" + description: "What did you think would happen?" + placeholder: "It shoulds ..." + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: "Actual behavior" + description: "What did actually happen? Add screenshots, if it's possiable." + placeholder: "It actually ..." + - type: dropdown + id: operating-system + attributes: + label: "Operating system" + description: "What OS is your server / device running on?" + options: + - Linux + - macOS + - Windows + - Something else + validations: + required: true + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Have you spent some time to check if this issue has been raised before?" + description: "Have you Googled for a similar issue or checked our older issues for a similar bug?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "Have you read the Code of Conduct?" + options: + - label: "I have read the [Code of Conduct](https://github.com/EbookFoundation/free-programming-books/blob/main/docs/CODE_OF_CONDUCT.md)" + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 000000000..d3e8d5a1a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,32 @@ +name: "Feature Request" +description: "Submit a proposal for a new feature" +title: "Feature: " +labels: [New Feature] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out our feature request form. + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "Feature description" + description: "A clear and concise description of what the feature is." + placeholder: "You should add ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Have you spent some time to check if this issue has been raised before?" + description: "Have you Googled for a similar issue or checked our older issues?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "Have you read the Code of Conduct?" + options: + - label: "I have read the [Code of Conduct](https://github.com/EbookFoundation/free-programming-books/blob/main/docs/CODE_OF_CONDUCT.md)" + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/urlchecker.yml b/.github/ISSUE_TEMPLATE/urlchecker.yml new file mode 100644 index 000000000..b0198f85c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/urlchecker.yml @@ -0,0 +1,32 @@ +name: "Broken Links Report" +description: "Submit a broken links report to help us improve" +title: "Broken Links Report: " +labels: [urlchecker] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out our report form. + - type: textarea + id: broken-links + validations: + required: true + attributes: + label: "Broken Links" + description: "Fill broken links that you found." + placeholder: "1. .../n 2. ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Have you spent some time to check if this issue has been raised before?" + description: "Have you Googled for a similar issue or checked our older issues for a similar bug?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "Have you read the Code of Conduct?" + options: + - label: "I have read the [Code of Conduct](https://github.com/EbookFoundation/free-programming-books/blob/main/docs/CODE_OF_CONDUCT.md)" + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7fb62bd40..d32ad33ee 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,20 +1,25 @@ ## What does this PR do? -Add resource(s) | Remove resource(s) | Add info | Improve repo -## For resources -### Description +- [ ] Add resource(s) +- [ ] Remove resource(s) +- [ ] Add/Update infomation +- [ ] Improve this repository -### Why is this valuable (or not)? +## Description -### How do we know it's really free? + -### For book lists, is it a book? For course lists, is it a course? etc. +## Why is this valuable (or not)? + +## How do we know it's really free? + +## Checklist -## Checklist: - [ ] Read our [contributing guidelines](https://github.com/EbookFoundation/free-programming-books/blob/main/docs/CONTRIBUTING.md). - [ ] [Search](https://ebookfoundation.github.io/free-programming-books-search/) for duplicates. +- [ ] It is a book or a course, etc. - [ ] Include author(s) and platform where appropriate. -- [ ] Put lists in alphabetical order, correct spacing. +- [ ] Put lists in alphabetical order, with correct spacing. - [ ] Add needed indications (PDF, access notes, under construction). - [ ] Used an informative name for this pull request.