Permalink
Browse files

Add issue templates and instruction for adding a new currency (#540)

  • Loading branch information...
sindresorhus committed Oct 8, 2018
1 parent c6c795e commit 53355297f73b3e00e933b5707849e0ef53a9e562
@@ -0,0 +1,8 @@
---
name: '💸 Add a currency'
about: 'Get a new currency added to HyperDEX'
---
<!-- -----------^ Click `Preview` for a nicer view! -->
See the [steps for adding a currency](../../docs/add-currency.md).
@@ -0,0 +1,40 @@
---
name: '🐛 Bug report'
about: 'Report an issue with HyperDEX'
---
**Describe the bug**
<!-- A clear and concise description of what the bug is. -->
**To reproduce**
<!-- Example
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. -->
**System info**
- OS & version:
- HyperDEX version:
<!-- Example
- OS & version: macOS 10.14
- HyperDEX version: 0.1.4
-->
**Additional context**
<!-- Add any other context about the problem here. -->
@@ -0,0 +1,16 @@
---
name: '🚀 Feature request'
about: 'Suggest an idea for HyperDEX'
---
**Describe the feature**
<!-- A clear and concise description of the feature and what problem it solves. -->
**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. -->
@@ -0,0 +1,6 @@
---
name: '🌈 Other'
about: 'Anything else'
---
<!-- Please try to write as clear and concise as possible. -->
View
@@ -93,6 +93,12 @@ We are planning to add an option to specify the number of confirmations your are
Please download the latest [nightly build](https://github.com/atomiclabs/hyperdex-nightlies/releases/latest) and report detailed issues with the "Feedback" button in the app.
## FAQ
#### How can I add a new currency?
[See the guide for adding a new currency.](docs/add-currency.md)
## Donate
HyperDEX is a free and open source project. You can help support its development by donating to the below addresses:
View
@@ -0,0 +1,27 @@
# Add a Currency
Instructions for getting a new cryptocurrency added to HyperDEX.
## Requirements
- The currency must be [Bitcoin-compatible](https://docs.komodoplatform.com/barterDEX/get-listed-barterDEX.html) or ERC20-based.
- If the currency is not ERC20-based, there must be at least 2 trusted Electrum servers for the currency. The servers should available on domains/subdomains, not IP addresses. Preferably subdomains on the official domain. Say the domain is `currency.com`, the Electrum servers should be at `electrum1.currency.com` and `electrum2.currency.com`.
## Proof
You must prove to us that the currency information is correct and that the Electrum servers are officially approved.
Examples:
- [Verify the domain listed on the GitHub organization](https://help.github.com/articles/verifying-your-organization-s-domain/).
- [Signed PGP message](https://keybase.io/hyperdex) from the currency team approving the change.
- Tweet/DM from official account approving the change.
## Steps
- Add the currency to https://github.com/jl777/coins. *(We use this repo as the source of truth)*
- Open an issue on https://github.com/atomiclabs/cryptocurrency-icons if the currency's icon is not already there. We will make an icon for the currency.
- When your pull request to `jl777/coins` has been merged, you can open a pull request on https://github.com/atomiclabs/hyperdex.
- Add the currency info [here](https://github.com/atomiclabs/hyperdex/blob/master/app/marketmaker/supported-currencies.js). *Note that the list is ordered alphabetically.*
- Add the block explorer [here](https://github.com/atomiclabs/hyperdex/blob/master/app/renderer/block-explorer.js). *Note that the list is ordered alphabetically.*
- In the pull request description, include information about the currency, like official website, CoinMarketCap page, Twitter, etc. Also include a link to your `jl777/coins` pull request.

0 comments on commit 5335529

Please sign in to comment.