Skip to content

Doc issue templates #3620

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

Merged
merged 4 commits into from
Nov 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,32 @@ name: "\U0001F41BBug report"
about: Something is wrong with Redux.
---

**Do you want to request a _feature_ or report a _bug_?**
## Do you want to request a _feature_ or report a _bug_?

(If this is a _usage question_, please **do not post it here**—post it on [Stack Overflow](http://stackoverflow.com/questions/tagged/redux) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.)

**What is the current behavior?**
### Prior Issues

**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.**
Are there any existing issues or PRs that relate to this problem? If so, link them here.

**What is the expected behavior?**
## Bug Reports

**Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?**
### What is the current behavior?

### Steps to Reproduce

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://codesandbox.io or similar.

### What is the expected behavior?

### Environment Details

Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?

## New Features

### What is the new or updated feature that you are suggesting?

### Why should this feature be included?

### What docs changes are needed to explain this?
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: "\U0001F4DD Documentation Fix"
about: Fixing a problem in an existing docs page
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to encourage folks to create issues for docs because it's basically writing words to remind you to write other words. It's a lot of wasted effort. PRs are the appropriate form, IMHO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmm... I get what you're saying, but I also am assuming there's going to be a bunch of discussion on how to tackle stuff for the docs rewrite. I'm also trying to use this template for my own benefit as I create issues for the specific pages that need to be reworked.

That said, if you want to remove the docs edit template, sure.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but that's a special case that definitely does warrant having the issues. I'm talking more about there being grammar or linking issues. An issue is just clutter for that kind of stuff.

---

## What docs page needs to be fixed?

- **Section**:
- **Page**:

## What is the problem?

## What should be changed to fix the problem?
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: "\U0001F4D6 New/Updated Documentation Content"
about: Adding a new docs page, or updating content in an existing docs page
---

## What docs page is being added or updated?

- **Section**:
- **Page**:

## For Adding New Content

### What kind of content category is this page (tutorial, how-to, explanation, reference)?

### Who is the intended target audience?

#### What knowledge are we assuming they have?

### What are the intended results or takeaways from reading this page?

### What is the most critical info they should learn?

## For Updating Existing Content

### What updates should be made to the page?

### Do these updates change any of the assumptions or target audience? If so, how do they change?
File renamed without changes.
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bugfix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: "\U0001F41B Bug fix or new feature"
about: Fixing a problem with Redux
---

## PR Type

### Does this PR add a new _feature_, or fix a _bug_?

### Why should this PR be included?

## Checklist

- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
- [ ] Is there an existing issue for this PR?
- _link issue here_
- [ ] Have the files been linted and formatted?
- [ ] Have the docs been updated to match the changes in the PR?
- [ ] Have the tests been updated to match the changes in the PR?
- [ ] Have you run the tests locally to confirm they pass?

## New Features

### What new capabilities does this PR add?

### What docs changes are needed to explain this?

## Bug Fixes

### What is the current behavior, and the steps to reproduce the issue?

### What is the expected behavior?

### How does this PR fix the problem?
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation-edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "\U0001F4DD Documentation Fix"
about: Fixing a problem in an existing docs page
---

## Checklist

- [ ] Is there an existing issue for this PR?
- _link issue here_
- [ ] Have the files been linted and formatted?

## What docs page needs to be fixed?

- **Section**:
- **Page**:

## What is the problem?

## What changes does this PR make to fix the problem?
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation-new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: "\U0001F4D6 New/Updated Documentation Content"
about: Adding a new docs page, or updating content in an existing docs page
---

## PR Type

**Does this PR add a _new_ page, or update an _existing_ page?**

## Checklist

- [ ] Is there an existing issue for this PR?
- _link issue here_
- [ ] Have the files been linted and formatted?

## What docs page is being added or updated?

- **Section**:
- **Page**:

## For Adding New Content

### What kind of content category is this page (tutorial, how-to, explanation, reference)?

### Who is the intended target audience?

#### What knowledge are we assuming they have?

### What are the intended results or takeaways from reading this page?

### What is the most critical info they should learn?

## For Updating Existing Content

### What updates should be made to the page?

### Do these updates change any of the assumptions or target audience? If so, how do they change?