mirror of https://github.com/waku-org/js-waku.git
Merge pull request #191 from status-im/templates
This commit is contained in:
commit
a8d922d19e
|
@ -1,3 +0,0 @@
|
|||
# Example Contributing Guidelines
|
||||
|
||||
This is an example of GitHub's contributing guidelines file. Check out GitHub's [CONTRIBUTING.md help center article](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) for more information.
|
|
@ -1,9 +1,43 @@
|
|||
- **I'm submitting a ...**
|
||||
[ ] bug report
|
||||
[ ] feature request
|
||||
[ ] question about the decisions made in the repository
|
||||
[ ] question about how to use this project
|
||||
<!-- Delete all but one category -->
|
||||
This is a **bug report/feature or change request/support request**
|
||||
|
||||
- **Summary**
|
||||
## Problem
|
||||
|
||||
- **Other information** (e.g. detailed explanation, stack traces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)
|
||||
<!--
|
||||
Describe in details the problem or scenario that you are facing or trying to solve
|
||||
|
||||
If this is a feature request, then focus on the WHY you want the change.
|
||||
E.g.: As a user of my dApp, I want to know that X happened when I do Y.
|
||||
|
||||
If this is a bug report or support, please provide a code snippet that reproduces the issue or relevant steps.
|
||||
Describe the actual behavior vs expected behavior.
|
||||
Please also include logs.
|
||||
-->
|
||||
|
||||
## Proposed Solutions
|
||||
|
||||
<!--
|
||||
Describe one or several (or none) solutions to fix the problem describe above.
|
||||
|
||||
If this is a feature request, then focus on WHAT or HOW you want to see the change happen.
|
||||
Feel free to itemize requirements. E.g.:
|
||||
|
||||
- Function `foo` must return information about `bar`.
|
||||
- Function `blah` must allow me to pass argument `boo`.
|
||||
|
||||
Or describe current vs wanted behavior.
|
||||
|
||||
If this is a bug report and you know how to fix the problem, feel free to include a proposal or open a PR.
|
||||
Or feel free to omit this section.
|
||||
-->
|
||||
|
||||
## Notes
|
||||
|
||||
<!--
|
||||
Add any miscellaneous note that are relevant to issue, including but not limited to:
|
||||
|
||||
- js-waku version
|
||||
- Environment (browser software and version, system software and version)
|
||||
- Nodes connected to too (e.g. Status test fleet)
|
||||
- etc
|
||||
-->
|
||||
|
|
|
@ -1,7 +1,21 @@
|
|||
- **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
|
||||
## Problem
|
||||
|
||||
- **What is the current behavior?** (You can also link to an open issue here)
|
||||
<!--
|
||||
Describe in details the problem or scenario that this PR is fixing.
|
||||
|
||||
- **What is the new behavior (if this is a feature change)?**
|
||||
If this is a feature addition or change, then focus on the WHY you are making the change.
|
||||
E.g.: As a user of my dApp, I want to know that X happened when I do Y.
|
||||
|
||||
- **Other information**:
|
||||
If this is a bug fix, please describe why the old behavior was problematic.
|
||||
-->
|
||||
|
||||
## Solution
|
||||
|
||||
<!-- describe the new behavior -->
|
||||
|
||||
## Notes
|
||||
|
||||
<!-- Remove items that are not relevant -->
|
||||
|
||||
- Resolves <issue number>
|
||||
- Related to <link to specs>
|
||||
|
|
Loading…
Reference in New Issue