Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve issue and PR templates #7712

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/urlchecker.yml
Original file line number Diff line number Diff line change
@@ -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
25 changes: 14 additions & 11 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
## 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?
<!-- 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).
- [ ] [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.

## Follow-up

- Check the status of GitHub Actions and resolve any reported warnings!
<!-- Follow-up: Check the status of GitHub Actions and resolve any reported warnings! -->