From 678c5216ac0f8ad0af2814a6cb699954531d34ec Mon Sep 17 00:00:00 2001 From: John Crossley Date: Wed, 10 Jun 2026 08:44:01 +0100 Subject: [PATCH] Added contribution guides --- .github/pull_request_template.md | 14 ++++++++++++++ CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ README.md | 5 +++++ 3 files changed, 46 insertions(+) create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..afb03c0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +## Summary + +Describe the problem and the proposed change. + +## Testing + +List the commands or manual checks used to verify the change. + +- [ ] `cargo fmt --check` +- [ ] `cargo test` + +## Contributor responsibility + +- [ ] I understand, tested, and take ownership of this change. It is not an unreviewed or fully automated AI-generated submission. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f517b81 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to Tofu CLI + +Thanks for considering a contribution. + +## Before opening a pull request + +- Keep changes focused on one problem. +- Open an issue before starting a large feature or behavioral change. +- Add or update tests when behavior changes. +- Run `cargo fmt --check` and `cargo test`. +- Update user-facing documentation when commands or output change. + +## AI-assisted contributions + +Using AI tools for research, learning, debugging, or drafting is welcome. +However, Tofu does not accept pull requests submitted without meaningful human +review and ownership. + +Contributors must understand, test, and be able to explain and maintain every +change they submit. Fully automated, bulk-generated, or low-effort AI pull +requests will be closed. + +## Pull requests + +Explain the problem being solved, the approach taken, and how the change was +tested. Keep unrelated refactoring out of the pull request. + diff --git a/README.md b/README.md index a1506f1..8a39e4c 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,11 @@ Tofu is not an ngrok replacement. Use ngrok, staging, a preview URL, or another Full quickstart and provider examples: [trytofu.dev/docs](https://trytofu.dev/docs) +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines, including +the policy for AI-assisted submissions. + ## License MIT