A repository's own CONTRIBUTING.md, with project-specific details, overrides this org-wide default.
- Be respectful. All interaction is governed by our Code of Conduct.
- Open an issue before significant work so we can discuss the approach.
- Keep changes focused: one logical change per pull request.
- Branch from the default branch as
<type>/<short-description>(for example,feat/add-widget), per the org's branch-naming convention. It is a convention, not a requirement: no check enforces it by default, though a repository may gate it locally. - Make your change, with tests where applicable.
- Ensure the project builds and its checks pass locally.
- Open a pull request, fill out the template, and link the related issue.
- Title it in Conventional Commits form with a standard type,
<type>[optional scope]: <description>, for examplefeat(api): add pagination. The title becomes the squash-merge commit subject on the default branch. - Where the repository enforces this, the
CI Statuscheck reports on your pull request and must pass before merge.
- Title it in Conventional Commits form with a standard type,
- Address review feedback. Pull requests are squash-merged once every review thread is resolved and any required checks pass.
Do not open public issues for vulnerabilities. See SECURITY.md.