From 285097c8260a0dcb0569a8b84706c121b5f8704a Mon Sep 17 00:00:00 2001 From: Matt Venables Date: Thu, 26 Mar 2026 13:18:10 -0400 Subject: [PATCH] docs: add AI usage policy and update contributing guide Introduce AI_POLICY.md with rules for AI-assisted contributions (disclosure and human understanding requirements) and add an AI Usage section to CONTRIBUTING.md referencing the new policy. Co-Authored-By: Claude Opus 4.6 (1M context) --- AI_POLICY.md | 33 +++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++------------ 2 files changed, 69 insertions(+), 12 deletions(-) create mode 100644 AI_POLICY.md diff --git a/AI_POLICY.md b/AI_POLICY.md new file mode 100644 index 0000000..8e1f8ec --- /dev/null +++ b/AI_POLICY.md @@ -0,0 +1,33 @@ +# AI Usage Policy + +Agent Commerce Kit welcomes AI-assisted contributions. We believe AI tools can +be a powerful part of any developer's workflow. However, we have clear rules to +ensure the quality and integrity of contributions. + +This policy ensures that every contributor -- whether using AI or not -- takes +responsibility for the code they submit. + +## Rules + +- **All AI usage in any form must be disclosed.** You must state the tool you + used (e.g. Claude Code, Cursor, Copilot) along with the extent that the work + was AI-assisted. + +- **The human-in-the-loop must fully understand all code.** If you can't explain + what your changes do and how they interact with the greater system without the + aid of AI tools, do not submit the contribution. + +## There are Humans Here + +Please remember that Agent Commerce Kit is maintained by humans. + +Every discussion, issue, and pull request is read and reviewed by humans. It is +a boundary point at which people interact with each other and the work done. +Please do not approach this boundary with low-effort, unqualified work, since it +puts the burden of validation on the maintainer. + +## AI is Welcome Here + +Agent Commerce Kit is written with plenty of AI assistance, and we embrace AI +tools as a productive part of our workflow. As a project, we welcome AI as a +tool! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9363481..6387e51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,12 @@ # Contributing to Agent Commerce Kit -We welcome contributions to Agent Commerce Kit! Here are a few ways you can help: +We welcome contributions to Agent Commerce Kit! Here are a few ways you can +help: ## Reporting Bugs -If you encounter a bug, please help us by reporting it. To report a bug, please open an issue on our GitHub repository. +If you encounter a bug, please help us by reporting it. To report a bug, please +open an issue on our GitHub repository. When filing a bug report, please include the following: @@ -12,11 +14,14 @@ When filing a bug report, please include the following: - Steps to reproduce the bug. - What you expected to happen. - What actually happened. -- Your environment details (e.g., OS, Node.js version, Agent Commerce Kit version). +- Your environment details (e.g., OS, Node.js version, Agent Commerce Kit + version). ## Suggesting Enhancements -We are always looking for ways to improve Agent Commerce Kit. If you have an idea for an enhancement, please open an issue on our GitHub repository. You can also reach us in our [Discord](https://discord.gg/FfWBmaSRmt). +We are always looking for ways to improve Agent Commerce Kit. If you have an +idea for an enhancement, please open an issue on our GitHub repository. You can +also reach us in our [Discord](https://discord.gg/FfWBmaSRmt). When suggesting an enhancement, please include: @@ -25,20 +30,39 @@ When suggesting an enhancement, please include: - Why this enhancement would be useful. - Any potential drawbacks or considerations. +## AI Usage + +**The most important rule: you must understand your code.** If you can't explain +what your changes do and how they interact with the greater system without the +aid of AI tools, please do not contribute to this project. + +Using AI to write code is fine. This project has specific rules for AI usage. +Please see the [AI Usage Policy](AI_POLICY.md). + ## Code Contributions -We welcome code contributions! If you would like to contribute code, please follow these steps: +We welcome code contributions! If you would like to contribute code, please +follow these steps: -1. **Fork the repository:** Create your own fork of the Agent Commerce Kit repository. -2. **Create a branch:** Create a new branch in your fork for your changes (e.g., `git checkout -b feature/your-feature-name` or `git checkout -b bugfix/issue-number`). +1. **Fork the repository:** Create your own fork of the Agent Commerce Kit + repository. +2. **Create a branch:** Create a new branch in your fork for your changes (e.g., + `git checkout -b feature/your-feature-name` or + `git checkout -b bugfix/issue-number`). 3. **Make your changes:** Implement your feature or bug fix. -4. **Commit your changes:** Commit your changes with a clear and descriptive commit message. -5. **Push to your branch:** Push your changes to your branch in your fork (e.g., `git push origin feature/your-feature-name`). -6. **Open a Pull Request (PR):** Open a pull request from your branch to the `main` branch of the Agent Commerce Kit repository. - - Ensure your PR description clearly describes the changes and links to any relevant issues. +4. **Commit your changes:** Commit your changes with a clear and descriptive + commit message. +5. **Push to your branch:** Push your changes to your branch in your fork (e.g., + `git push origin feature/your-feature-name`). +6. **Open a Pull Request (PR):** Open a pull request from your branch to the + `main` branch of the Agent Commerce Kit repository. + - Ensure your PR description clearly describes the changes and links to any + relevant issues. ## Code of Conduct -Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. +Please note that this project is released with a +[Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this +project you agree to abide by its terms. Thank you for contributing to Agent Commerce Kit!