COLLABORATOR_GUIDE.md
As a collaborator, you help administer axios. This guide covers the responsibilities that come with that access. For architecture, lifecycle, security-sensitive code, and conventions, use AGENTS.md, the canonical contributor guide.
Read the Code of Conduct and help enforce it. Keep the community friendly and welcoming.
Be helpful and patient. If a question comes from unclear docs, update the docs and consider adding an example instead of only answering in the thread. You are not expected to teach JavaScript or unrelated tooling. Redirect those questions politely.
When opening a PR, make sure:
index.d.ts (ESM) and index.d.cts (CJS) when the public API changes.AxiosError with an appropriate code, never raw Error. Wrap third-party errors with AxiosError.from.package-lock.json changes must keep lockfile-lint happy (npm HTTPS hosts, integrity hashes).fix:, feat:, chore:, docs:, etc.). Release tooling depends on this.v1.x for the current maintenance line; breaking work goes elsewhere).At least one maintainer must review and approve a PR before merge. If you are unsure about the impact of a change, ask for a second opinion. Call out breaking changes in the PR description and send them to the appropriate branch. Bug fixes need a test that reproduces the issue and verifies the fix.
If changes are requested, address them promptly. If you cannot make the changes, say so clearly so someone else can pick them up.
[!IMPORTANT] We wait up to 28 days for a response to requested changes before closing the PR as stale. After that, we will either address the issue in a maintainer-led PR or open an issue for other contributors. If the author wants to continue the work, they should recreate the PR from the latest version of the correct target branch, address all feedback, and request review from a maintainer.
If someone reports a suspected vulnerability in a public issue, do not discuss specifics in the thread. Redirect them to the process described in SECURITY.md (GitHub security advisories) and close or hide the issue as appropriate.
ignore-scripts in .npmrc or otherwise weaken install-time safety.beforeRedirect, proxy, socketPath, XSRF, or prototype-pollution safeguards without tests covering the regression cases.Thanks for helping keep axios healthy. If you are unsure about a call, ask another collaborator before acting. We would rather move a little slower than ship a regression. If you have questions about your role or responsibilities, contact the maintainers.