forked from Consensys/doc.teku
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add issue and PR templates (Consensys#289)
- Loading branch information
1 parent
cd48892
commit 7aae7db
Showing
3 changed files
with
154 additions
and
7 deletions.
There are no files selected for viewing
This file contains 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,43 @@ | ||
--- | ||
name: Doc content issue report | ||
about: Create a report to help us improve our content. | ||
title: '' | ||
|
||
--- | ||
|
||
<!-- **IMPORTANT: this is only for reporting documentation content issues.** | ||
- Report Teku software issues at https://github.com/consensys/teku. | ||
- Report doc tool issues using the "Doc tool bug report" template. | ||
**Before creating a bug**, have you tried using the search field in the documentation | ||
to find what you're looking for? | ||
--> | ||
|
||
## Describe the bug | ||
|
||
<!-- A clear and concise description of what the doc issue is. | ||
Check the issue type in the following list (insert X instead of space between [ ]): --> | ||
|
||
- [ ] Missing content | ||
- [ ] Outdated content | ||
- [ ] Wrong content | ||
- [ ] Confusing or misleading content | ||
- [ ] Other | ||
|
||
## The broken page | ||
|
||
[Paste the doc site page link here.] | ||
|
||
## Change suggestion | ||
|
||
<!-- If you know how to fix the content, you may provide a suggestion. --> | ||
|
||
## Screenshots | ||
|
||
<!-- If it helps to understand the issue, you may link an annotated screenshot or a small demo video. --> | ||
|
||
## More context | ||
|
||
<!-- Add any other context about the problem here. --> |
This file contains 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,48 @@ | ||
--- | ||
name: Doc tool bug report | ||
about: Create a report to help us improve our doc tools. | ||
title: '' | ||
|
||
--- | ||
|
||
<!-- **IMPORTANT: this is only for reporting documentation tools bugs.** | ||
- Report Teku software issues at https://github.com/consensys/teku. | ||
- Report doc content issues using the "Doc content issue report" template. | ||
**Before creating a bug**, did you try refreshing your browser cache for our site? | ||
--> | ||
|
||
## Describe the bug | ||
|
||
<!-- A clear and concise description of what the doc bug is. --> | ||
|
||
## The broken page | ||
|
||
[Paste the doc site page link here.] | ||
|
||
## System (please complete the following information) | ||
|
||
- OS: [Windows, macOS, Linux] and its version. | ||
- Browser: [Chrome, Firefox, Safari,…] and its version. | ||
- Plugins: list plugins activated in your Browser. | ||
|
||
## To Reproduce | ||
|
||
Steps to reproduce the behavior: | ||
1. Go to page '…' | ||
2. Click on '…' | ||
3. Scroll down to '…' | ||
4. See error | ||
|
||
## Expected behavior | ||
|
||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## Screenshots | ||
|
||
<!-- If it helps to understand the issue, you may link an annotated screenshot or a small demo video. --> | ||
|
||
## More context | ||
|
||
<!-- Add any other context about the problem here. --> |
This file contains 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 |
---|---|---|
@@ -1,9 +1,65 @@ | ||
<!-- Thanks for sending a pull request! Please check out our contribution guidelines: --> | ||
<!-- https://github.com/Consensys/doc.common/wiki/Contributing-to-Documentation --> | ||
## Pull request checklist | ||
|
||
## Pull Request Description | ||
<!-- Please write a short description of your changes and any specific instructions to review them --> | ||
Use the following list to make sure your PR fits the Teku doc quality standard. | ||
|
||
## Fixed Issue(s) | ||
<!-- Please link to fixed issue(s) here using format: fixes #<github issue number> --> | ||
<!-- Example: "fixes #42" --> | ||
### Before creating the pull request | ||
|
||
Make sure that: | ||
|
||
- [ ] you have read the [contribution guidelines](https://github.com/ConsenSys/doc.common/wiki/Contributing-to-Documentation). | ||
- [ ] you have [tested your changes locally](https://github.com/ConsenSys/doc.common/wiki/MkDocs-And-Custom-Markdown-Guide#preview-documentation-site-locally) before submitting them to the community for review. | ||
|
||
### After creating your pull request and tests finished | ||
|
||
Make sure that: | ||
|
||
- [ ] you have fixed all the issues raised by the tests, if any. | ||
- [ ] you have verified the rendering of your changes on | ||
[ReadTheDocs.org PR preview](https://github.com/ConsenSys/doc.common/wiki/MkDocs-And-Custom-Markdown-Guide#preview-the-doc-site-for-your-pr-on-readthedocscom) | ||
and updated the testing link (see [Testing](#testing)). | ||
|
||
## Describe the change | ||
|
||
<!-- A clear and concise description of what this PR changes in the documentation. --> | ||
|
||
## Issue fixed | ||
|
||
<!-- Except for minor changes (typos, commas) it's required to have a Github issue linked to your | ||
pull request. | ||
Use the following to make Github close the issue automatically when merging the PR: | ||
fixes #{your issue number} | ||
If multiple issues are involved, use one line for each issue. | ||
If you don't want to close the issue, use: | ||
see #{your issue number} --> | ||
|
||
## Impacted parts <!-- check as many boxes as needed --> | ||
|
||
### For content changes | ||
|
||
- [ ] Doc content | ||
- [ ] Doc pages organisation | ||
|
||
### For tools changes | ||
|
||
- [ ] CircleCI workflow | ||
- [ ] Build and QA tools (lint, vale,…) | ||
- [ ] MkDocs templates | ||
- [ ] MkDocs configuration | ||
- [ ] Python dependencies | ||
- [ ] Node dependencies and JavaScript | ||
- [ ] ReadTheDocs configuration | ||
- [ ] GitHub integration | ||
|
||
## Testing | ||
|
||
<!-- Steps to follow to review and test your changes. | ||
Add links to preview the pages changes here. | ||
Link format is https://pegasys-teku--{your PR number}.org.readthedocs.build/en/{your PR number}/ | ||
Where {your PR number} must be replaced by the number of this PR, for instance 123 | ||
--> | ||
|
||
## Screenshots / recording | ||
|
||
<!-- If it helps to understand your change, you may link an annotated screenshot or a small demo video. --> |