Skip to content

Commit

Permalink
Add workflow to validate JSON (#52)
Browse files Browse the repository at this point in the history
* Add workflow to validate JSON

* merge jobs

* break list to test the validation script

* revert the break

* add CONTRIBUTING.md

* bump up list version

* formatting
  • Loading branch information
shazarre committed Mar 1, 2024
1 parent e7d963f commit a3ce633
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 1 deletion.
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:
pull_request:
push:
branches:
- main

jobs:
validate_list:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Use Node.js 20
uses: actions/setup-node@v4
with:
node-version: 20

- run: npm install
- run: npm test
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing

You're welcome to contribute to this repository directly by creating a PR.

To do so, please follow the steps:

1. Clone the repository

```bash
git clone git@github.com:celo-org/celo-token-list.git
```

2. Install the dependencies

```bash
npm install
```

3. Make changes...

4. (optional) Run validation check

```bash
npm run test
```

4. Commit and push your changes

```bash
git checkout -b "<your-branch-name>"
git commit -m "<your-commit-message>"
git push origin <your-branch-name>
```

5. Raise a PR using GitHub UI

Thanks!
2 changes: 1 addition & 1 deletion celo.tokenlist.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": {
"major": 2,
"minor": 4,
"patch": 0
"patch": 1
},
"logoURI": "https://celo-org.github.io/celo-token-list/assets/celo_logo.svg",
"keywords": ["celo", "tokens", "refi"],
Expand Down

0 comments on commit a3ce633

Please sign in to comment.