-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #95 from rsksmart/feat/add-feature-request-bug-rep…
…ort-templates Update issue templates for contributors
- Loading branch information
Showing
4 changed files
with
93 additions
and
0 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,37 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
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 applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional 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,19 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
**Is your feature request related to a problem with the content or with the docs platform? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request 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,10 @@ | ||
## What | ||
* Specify new changes introduced within the docs repo... | ||
|
||
## Why | ||
* Specify why this change is needed... | ||
* Add/tag related issues, if available... | ||
|
||
## Refs | ||
* Add related links (tasks, notion, or jira) | ||
* Add NA if not applicable |
27 changes: 27 additions & 0 deletions
27
.github/PULL_REQUEST_TEMPLATE/pull_request_template_main.md
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,27 @@ | ||
## Title | ||
* Clear and concise description of the change | ||
|
||
## Description | ||
|
||
* Briefly explain the purpose of the change. | ||
* If applicable, describe the issue that was resolved or the feature that was added. | ||
* Highlight the specific changes made to the documentation. | ||
|
||
## Screenshots/GIFs | ||
|
||
* Include any relevant screenshots or GIFs to visually demonstrate the changes. | ||
|
||
## Testing | ||
|
||
* Describe how you tested the changes to ensure they are correct and do not introduce new issues. | ||
|
||
## Checklist | ||
|
||
[ ] I have read and understood the contributing guidelines. | ||
[ ] I have followed the style guide and formatting guidelines. | ||
[ ] I have added appropriate comments to explain the changes. | ||
[ ] I have tested my changes thoroughly. | ||
|
||
## Additional Notes | ||
|
||
* If there are any specific considerations or concerns, please mention them here. |