update PR and issue templates (#1018)
* update PR and issue templates Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * update PR and issue templates Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * fix contributing.md Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>pull/1023/head
Alexandra Tran
3 years ago
committed by
GitHub
parent
05ff3c7790
commit
d0586a9455
@ -1,66 +1,60 @@ |
||||
## Pull request checklist |
||||
|
||||
Use the following list to make sure your PR fits the Besu doc quality standard. |
||||
Use the following list to make sure your PR fits the Besu documentation quality standard. |
||||
|
||||
### Before creating the pull request |
||||
|
||||
Make sure that: |
||||
|
||||
- [ ] [all commits in this PR are signed off for the DCO](https://wiki.hyperledger.org/display/BESU/DCO). |
||||
- [ ] you read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Contributing+to+documentation). |
||||
- [ ] you have [tested your changes locally](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewTheDocumentation) before submitting them to the community for review. |
||||
|
||||
### After creating your pull request and tests finished |
||||
|
||||
Make sure that: |
||||
|
||||
- [ ] you fixed all the issues raised by the tests, if any. |
||||
- [ ] you verified the rendering of your changes on [ReadTheDocs.org PR preview](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewwithReadTheDocs) |
||||
and updated the testing link (see [Testing](#testing)). |
||||
- [ ] [All commits in this PR are signed off for the DCO](https://wiki.hyperledger.org/display/BESU/DCO). |
||||
- [ ] You've read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Documentation). |
||||
- [ ] You've [previewed your changes locally](https://wiki.hyperledger.org/display/BESU/Preview+the+documentation). |
||||
|
||||
## Describe the change |
||||
|
||||
<!-- A clear and concise description of what this PR changes in the documentation. --> |
||||
<!-- Add a clear and concise description of what your 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. |
||||
<!-- Link to the GitHub issue that your PR addresses. |
||||
|
||||
Add "fixes #{your issue number}" to close the issue automatically when the PR is merged. |
||||
|
||||
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 your PR doesn't completely fix the issue, add "see #{your issue number}" to link to the issue |
||||
without automatically closing it. --> |
||||
|
||||
If you don't want to close the issue, use: |
||||
see #{your issue number} --> |
||||
## Impacted parts |
||||
|
||||
## Impacted parts <!-- check as many boxes as needed --> |
||||
<!-- Check the item from the following lists that your PR impacts. You can check multiple boxes. --> |
||||
|
||||
### For content changes |
||||
For content changes: |
||||
|
||||
- [ ] Doc content |
||||
- [ ] Doc pages organisation |
||||
- [ ] Documentation content |
||||
- [ ] Documentation page organization |
||||
|
||||
### For tools changes |
||||
For tool changes: |
||||
|
||||
- [ ] CircleCI workflow |
||||
- [ ] Build and QA tools (lint, vale,…) |
||||
- [ ] Build and QA tools (for example, lint or vale) |
||||
- [ ] MkDocs templates |
||||
- [ ] MkDocs configuration |
||||
- [ ] Python dependencies |
||||
- [ ] Node dependencies and JavaScript |
||||
- [ ] ReadTheDocs configuration |
||||
- [ ] Read the Docs configuration |
||||
- [ ] GitHub integration |
||||
|
||||
## Testing |
||||
## After creating your PR and tests have finished |
||||
|
||||
<!-- Steps to follow to review and test your changes. |
||||
Add links to preview the pages changes here. |
||||
Link format is https://hyperledger-besu--{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 |
||||
--> |
||||
Make sure that: |
||||
|
||||
- [ ] You've fixed any issues raised by the tests. |
||||
- [ ] You've [previewed your changes on Read the Docs](https://wiki.hyperledger.org/display/BESU/Preview+the+documentation) |
||||
and added a [preview link](#preview). |
||||
|
||||
## Screenshots / recording |
||||
## Preview |
||||
|
||||
<!-- If it helps understanding your change, |
||||
don't hesitate to link an annotated screenshot or a small demo video. --> |
||||
<!-- Add the link to preview your changes on Read the Docs. |
||||
|
||||
The link format is "https://hyperledger-besu--{your PR number}.org.readthedocs.build/en/{your PR number}/", |
||||
where {your PR number} is replaced by the number of this PR. |
||||
--> |
||||
|
||||
@ -1,32 +1,4 @@ |
||||
# Contributing to the Hyperledger Besu documentation |
||||
# Contribute to the Hyperledger Besu documentation |
||||
|
||||
## Thanks for taking the time to contribute |
||||
|
||||
Welcome to the **Hyperledger Besu documentation** repository! The following are links to a set of |
||||
guidelines (not rules) for contributing to this repository. Use your best judgement, and feel free |
||||
to propose changes to this document in a pull request. |
||||
|
||||
* [Hyperledger Besu documentation](http://besu.hyperledger.org/) |
||||
* [Hyperledger Besu community](https://discord.gg/hyperledger) |
||||
* [Hyperledger Besu Wiki](https://wiki.hyperledger.org/display/BESU/Hyperledger+Besu) |
||||
|
||||
### Useful docs contributing links |
||||
|
||||
* [I just have a quick question] |
||||
* [How to contribute](https://wiki.hyperledger.org/display/BESU/How+to+Contribute) |
||||
* [Reporting bugs in the documentation] |
||||
* [Submitting a documentation enhancement suggestion] |
||||
* [Documentation style guide] |
||||
* [Security](SECURITY.md) |
||||
|
||||
### Other important information |
||||
|
||||
* [Besu roadmap](https://wiki.hyperledger.org/display/BESU/Roadmap) |
||||
* [Code of Conduct](https://wiki.hyperledger.org/display/BESU/Code+of+Conduct) |
||||
* [Governance](https://wiki.hyperledger.org/display/BESU/Governance) |
||||
|
||||
<!-- Links --> |
||||
[I just have a quick question]: https://wiki.hyperledger.org/display/BESU/I+just+have+a+quick+question |
||||
[Reporting bugs in the documentation]: https://wiki.hyperledger.org/display/BESU/Reporting+Bugs+in+the+Documentation |
||||
[Submitting a documentation enhancement suggestion]: https://wiki.hyperledger.org/display/BESU/Suggesting+Documentation+Enhancements |
||||
[Documentation style guide]: https://wiki.hyperledger.org/display/BESU/Besu+Documentation+Style+Guide |
||||
See the [documentation section in the Hyperledger Besu wiki](https://wiki.hyperledger.org/display/BESU/Documentation) |
||||
for guidelines on how to contribute to the documentation. |
||||
|
||||
Loading…
Reference in new issue