-
-
Notifications
You must be signed in to change notification settings - Fork 15.2k
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
Doc issue templates #3620
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- | ||
|
||
## What docs page needs to be fixed? | ||
|
||
- **Section**: | ||
- **Page**: | ||
|
||
## What is the problem? | ||
|
||
## What should be changed to fix the problem? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.