improve issue and PR templates
parent
fe13441429
commit
5094d3cbde
|
@ -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
|
|
@ -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
|
|
@ -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
|
|
@ -1,20 +1,25 @@
|
||||||
## What does this PR do?
|
## What does this PR do?
|
||||||
Add resource(s) | Remove resource(s) | Add info | Improve repo
|
|
||||||
|
|
||||||
## For resources
|
- [ ] Add resource(s)
|
||||||
### Description
|
- [ ] Remove resource(s)
|
||||||
|
- [ ] Add/Update infomation
|
||||||
|
- [ ] Improve this repository
|
||||||
|
|
||||||
### Why is this valuable (or not)?
|
## Description
|
||||||
|
|
||||||
### How do we know it's really free?
|
<!-- Provide a description of what this PR does -->
|
||||||
|
|
||||||
### 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).
|
- [ ] 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.
|
- [ ] [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.
|
- [ ] 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).
|
- [ ] Add needed indications (PDF, access notes, under construction).
|
||||||
- [ ] Used an informative name for this pull request.
|
- [ ] Used an informative name for this pull request.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue