Update ISSUE_TEMPLATE.md

pull/524/head
Daniel Meyer 3 years ago committed by GitHub
parent 38d31009a1
commit aaf3df613e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 56
      ISSUE_TEMPLATE.md

@ -1,49 +1,21 @@
<!--
!!!
REMOVE EVERYTHING WRITTEN IN UPPERCASE BEFORE YOU CLICK SUBMIT
!!!
-->
<!-- IMPORTANT:
If you have a common question which cannot be solved with a PR,
DO NOT CREATE AN ISSUE!
You can go here these to ask for help:
- https://ethereum.stackexchange.com/
- https://www.reddit.com/r/ethdev/
- https://gitter.im/ethereum/web3.js
-->
<!-- DID YOU KNOW?
Over 50% of our bug-issues are not bugs.
When you reproduce the bug in our bug-template
you do not have to wait for the maintainers answer
and very likely solve your problem in the next 15 minutes.
https://github.com/pubkey/eth-crypto/blob/master/test/bug-template.test.js
-->
## Case
<!-- IS IT A BUG OR A REQUEST FOR A NEW FEATURE OR SOMETHING ELSE? -->
# STOP: DO NOT CREATE AN ISSUE!
## Issue
<!-- DESCRIBE WHY YOU OPEN THIS ISSUE -->
It is very unlikely that you want to create an issue.
## Info <!-- ONLY NEEDED FOR BUGS -->
- Environment: (Node.js/browser/electron/etc..)
- Adapter: (IndexedDB/Localstorage/LevelDB/etc..)
- Stack: (Typescript, Babel, Angular, React, etc..)
## You have found a bug?
-> Create a pull request where you tried to reproduce the problem or at least haven shown that you tried to do so.
You can start by editing this file: https://github.com/pubkey/eth-crypto/blob/master/test/bug-template.test.js
## Code
## You have a feature request?
-> Create a pull request that shows how the API would change or how the new feature could be used.
```js
const messageHash = EthCrypto.hash.keccak256(message);
const signature = EthCrypto.sign(testData.privateKey, messageHash);
/* ... */
```
<!--
IF YOU HAVE A BUG, WRITE CODE HERE TO REPRODUCE IT.
BUGS WONT BE TOUCHED BY THE MAINTAINER UNTIL THERE IS SOME CODE!
## You have a common question which cannot be solved with a PR
-> Ask it at one of these places:
- https://ethereum.stackexchange.com/
- https://www.reddit.com/r/ethdev/
- https://gitter.im/ethereum/web3.js
OPTIMALLY YOU SHOULD ADD A PULL-REQUEST WHICH REPRODUCES THE BUG
BY MODIFYING THIS FILE: https://github.com/pubkey/eth-crypto/blob/master/test/bug-template.test.js
## Everything else will likely be autoclosed. The maintainers time is as same as valuable as yours.
You are also a developer! You can fix stuff by yourself.
-->

Loading…
Cancel
Save