-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
Showing
3 changed files
with
60 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters