axios/CONTRIBUTING.md

Contributing

We accept community contributions. By contributing to axios, you agree to follow the code of conduct.

Code style

Follow the node style guide.

Commit messages

Follow conventional commits.

Testing

Update tests for your changes. Pull requests must pass GitHub Actions.

Documentation

Update the documentation when the API changes, so the API and docs stay in sync.

Dependency and GitHub Actions updates

Please do not open pull requests that only update npm packages, lockfiles, or GitHub Actions versions. We close these PRs from outside collaborators. Only maintainers and approved automated bots may create package and GitHub Actions update PRs.

We keep the 7-day Dependabot delay for these updates unless a critical vulnerability requires a maintainer-led manual update.

Developing

• npm run test runs the Jasmine and Mocha tests
• npm run build runs Rollup and bundles the source
• npm run version prepares the code for release

Running examples

Use the examples for manual testing.

Run the examples:

> npm run examples
# Open 127.0.0.1:3000

Run the browser sandbox:

> npm start
# Open 127.0.0.1:3000

Run the terminal sandbox:

> npm start
> node ./sandbox/client