diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19e6058..021ca33 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing +_Contributions are subject to CARTO's [community contributions policy](https://carto.com/contributions/)._ + ## Local development requirements - Yarn v4+ @@ -7,6 +9,8 @@ ## Quickstart +To install and build `@carto/api-client` locally from source: + ```bash # install dependencies yarn @@ -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 @@ -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.