diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..fa5d5c8a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1 @@ +See @CONTRIBUTING.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 00000000..47dc3e3d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..03a69bc8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing Guidelines + +## Submitting a pull request + +If the pull request is not yet ready to be reviewed by the maintainers, ensure it is marked as "Draft". When it is ready, mark it as "Ready for Review". + +Before marking a pull request as ready for review, ensure: + +* Commits are cleanly separated and have useful (but concise) messages that explain WHAT changed and WHY. +* A changelog entry has been added to CHANGELOG.md under `## Unreleased`. Changelogs should be concise and focused on the end user. +* Code has been appropriately documented (doc comments, etc.) Documentation should be clear and thorough but not excessively verbose or repetitive. +* Code is appropriately formatted with `cargo fmt`. +* Test coverage is excellent and passes with `--all-features` enabled. +* Reference related issues with "closes #N" at the bottom of commit messages. +* If an issue or pull request has been created with assistance from AI tooling, the contributor MUST review their contributions before posting them. + +## AI-assisted contributions policy + +The following policy is adapted from [Astral's AI contributions policy](https://github.com/astral-sh/.github/blob/main/AI_POLICY.md) + +We allow using AI (e.g. LLMs) as tools for coding. However, you remain responsible for any code you publish, and we are responsible for any code we merge and release. + +Contributing to this project means vouching for the quality, license compliance, and utility of your submission. + +If you are opening an issue or pull request, we expect you to be able to explain the issue and/or proposed changes in your own words. This includes the issue / pull request body and responses to questions. **Do not copy responses from the AI when replying to questions from maintainers.** + +Autonomous AI agents should not be used to reply to questions from maintainers. If you wish to include context from an interaction with AI in your comments, it must be in a quote block (e.g., using >) and disclosed as such. It must also be reviewed by the contributor for relevance and accuracy and accompanied by human commentary explaining the implications of the context. + +Contributions which appear in violation of this policy may be be closed, perhaps without notice. diff --git a/Changelog.md b/Changelog.md index 0b56fe07..04ff1a3e 100644 --- a/Changelog.md +++ b/Changelog.md @@ -27,8 +27,10 @@ ### Misc Changes -[#977]: https://github.com/tafia/quick-xml/issues/977 +- [#983]: Adopted an AI use and contribution policy for new upstream contributions. +[#977]: https://github.com/tafia/quick-xml/issues/977 +[#983]: https://github.com/tafia/quick-xml/issues/983 ## 0.41.0 -- 2026-06-29