Skip to content

Commit

Permalink
docs: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
radiovisual committed Apr 22, 2024
1 parent 97e16df commit edd42ff
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<!--
<!--
WAIT! Are you requesting a change to a specific cryptocurrency?
If yes, keep in mind that this list is generated automatically from the data on the cryptocompare API (via https://www.cryptocompare.com) so if you are requesting that a change be made to a specific currency, then the change would need to be made upstream on the cryptocpmare API. To do this, you would need to contact the support team at crytocompare (Visit https://www.cryptocompare.com
If yes, keep in mind that this list is generated automatically from the data on the cryptocompare API (via https://www.cryptocompare.com) so if you are requesting that a change be made to a specific currency, then the change would need to be made upstream on the cryptocompare API. To do this, you would need to contact the support team at cryptocompare (Visit https://www.cryptocompare.com
and click on the 'Contact us' link in the footer).
But if the change you need is already on the crytocompare API and not on this list, then you can submit a PR after you run `npm run build` to ensure that the current list is up-to-date. Or open an issue with a request to update the list.
But if the change you need is already on the cryptocompare API and not on this list, then you can submit a PR after you run `npm run build` to ensure that the current list is up-to-date, or open an issue with a request to update the list.
-->
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!--
<!--

WAIT! If you are attempting to submit a PR that makes a manual change to currency. Please don't.

This list is generated automatically from the data on the cryptocompare API (via https://www.cryptocompare.com) so if you are requesting that a change be made to a specific currency, then the change would need to be made upstream on the cryptocpmare API. To do this, you would need to contact the support team at crytocompare (Visit https://www.cryptocompare.com
This list is generated automatically from the data on the cryptocompare API (via https://www.cryptocompare.com) so if you are requesting that a change be made to a specific currency, then the change would need to be made upstream on the cryptocompare API. To do this, you would need to contact the support team at cryptocompare (Visit https://www.cryptocompare.com
and click on the 'Contact us' link in the footer). Once the data is on the API, then you can submit a PR after running `npm run build` to ensure that the current list is up-to-date.

If you submit a PR with a manual edit to any specific currency, it will be closed, because any manual changes you make would be overwritten the next time the list is generated, this is why the data needs to be on the API, because that is our single source of truth for this list.
If you submit a PR with a manual edit to any specific currency, it will be closed, because any manual changes you make would be overwritten the next time the list is auto-generated, this is why the data needs to be on the API, because that is our single source of truth for this list.
-->
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: CI
on:
- push
- pull_request
jobs:
test:
name: Node.js ${{ matrix.node-version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
node-version:
- 18
- 20
- latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm install
- run: npm test

0 comments on commit edd42ff

Please sign in to comment.