Skip to content
This repository has been archived by the owner on Apr 4, 2024. It is now read-only.

Commit

Permalink
add issue and PR templates (#113)
Browse files Browse the repository at this point in the history
* add issue and PR templates

* updating submodule to latest
  • Loading branch information
alexandratran authored May 28, 2021
1 parent 82565fa commit 2aa2a24
Show file tree
Hide file tree
Showing 4 changed files with 155 additions and 7 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/content_issue.md
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 EthSigner software issues at https://github.com/ConsenSys/ethsigner.
- 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. -->
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/tool_issue.md
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 EthSigner software issues at https://github.com/ConsenSys/ethsigner.
- 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. -->
69 changes: 63 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,65 @@
<!-- Thanks for sending a pull request! Please check out our contribution guidelines: -->
<!-- https://github.com/PegaSysEng/doc.ethsigner/blob/master/CONTRIBUTING.md -->
## Pull request checklist

## Pull Request Description
Use the following list to make sure your PR fits the EthSigner doc quality standard.

## Fixed Issue(s)
<!-- Please link to fixed issue(s) here using format: fixes ES-<Jira issue number> -->
<!-- Example: "fixes ES-1234" -->
### 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-ethsigner--{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. -->
2 changes: 1 addition & 1 deletion common

0 comments on commit 2aa2a24

Please sign in to comment.