From ed3dc121b46ecea5a8d84d146aaea5a8d572936c Mon Sep 17 00:00:00 2001 From: Aaron Date: Sun, 25 Oct 2026 17:59:04 -0500 Subject: [PATCH] docs: Add AI policy to `CONTRIBUTING.md` --- CONTRIBUTING.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c4487726..5e6000e50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,19 +19,26 @@ I also want to provide a way for developers to use either one of those two thing > The few runtime utils shipped inside WXT are things that should be used by 90% of extensions. That said, they're also legacy utils left in from before I started creating separate NPM packages, and in the future, they may be removed from the core package. -## Conventional Commits +## AI Policy -This project uses [Conventional Commit format](https://www.conventionalcommits.org/en/v1.0.0/) to automatically generate a changelog and better understand the changes in the project +You are free to use AI agents to contribute to WXT in almost any way you see fit, **except for PR descriptions**. + +Please respect the maintainers time by writing the PR description yourself. This forces you to at least attempt to understand what the change does and why to minimize it instead of just trusting the AI's output. This speeds up the human review process. If you're not comfortable writing in English, write the description in your preferred language and maintainers will translate it themselves. + +If a maintainer suspects the PR description is AI generated, they have the right to close it. If this happens to you, update the description and reopen it. + +## Conventional Commits & PR Titles + +This project uses [Conventional Commit format](https://www.conventionalcommits.org/en/v1.0.0/) to automatically generate a changelog and better understand the changes in the project. The title of your pull request should also follow this format, as it will be used as the squashed commit message when merged into the main branch, and ultimately used to generate the changelog for each release. Here are some examples of conventional commit messages: - `feat: add new functionality` -- `fix: correct typos in code` -- `ci: add GitHub Actions for automated testing` - -## Conventional PR Titles +- `fix: add optional chaining` +- `chore: fixed typos in code` +- `docs: updated list of features on homepage` -The title of your pull request should follow the [conventional commit format](#conventional-commits). When a pull request is merged to the main branch, all changes are going to be squashed into a single commit. The message of this commit will be the title of the pull request. And for every release, the commit messages are used to generate the changelog. +## Pull Requests ## Breaking Changes Policy