Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
donmccurdy authored Jun 28, 2024
1 parent 46d56c0 commit 5e61007
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Contributing

_Contributions are subject to CARTO's [community contributions policy](https://carto.com/contributions/)._

## Local development requirements

- Yarn v4+
- Node.js v18+

## Quickstart

To install and build `@carto/api-client` locally from source:

```bash
# install dependencies
yarn
Expand All @@ -21,9 +25,9 @@ yarn build --watch
yarn dev
```

After running `yarn dev`, a browser window will open with links to examples. Local URL will be `localhost:5173`, or may use another available port number.
After running `yarn dev`, a browser window will open with links each example. The local URL will generally be `localhost:5173`.

Tests, coverage, and other developmen-related scripts are defined in `package.json#scripts`.
To run tests, coverage, or a linter:

```bash
# run tests once
Expand All @@ -42,6 +46,8 @@ yarn lint
yarn format
```

Tests, coverage, and other development-related scripts are defined in `package.json#scripts`.

## Releases

> **TODO:** Configure an automatic release process with GitHub actions.
Expand Down

0 comments on commit 5e61007

Please sign in to comment.