From c62db7be063718cb8eee615768180e10f6b51a4a Mon Sep 17 00:00:00 2001 From: Gregory Schier Date: Fri, 20 Feb 2026 14:08:34 -0800 Subject: [PATCH] Add contribution policy docs and PR checklist template --- .github/pull_request_template.md | 18 ++++++++++++++++++ CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 6 ++++-- 3 files changed, 38 insertions(+), 2 deletions(-) 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 00000000..33c88d65 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +## Summary + + + +## Submission + +- [ ] This PR is a bug fix or small-scope improvement. +- [ ] If this PR is not a bug fix or small-scope improvement, I linked an approved feedback item below. +- [ ] I have read and followed [`CONTRIBUTING.md`](CONTRIBUTING.md). +- [ ] I tested this change locally. +- [ ] I added or updated tests when reasonable. + +Approved feedback item (required if not a bug fix or small-scope improvement): + + +## Related + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c16193f8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing to Yaak + +Yaak accepts community pull requests for: + +- Bug fixes +- Small-scope improvements directly tied to existing behavior + +Pull requests that introduce broad new features, major redesigns, or large refactors are out of scope unless explicitly approved first. + +## Approval for Non-Bugfix Changes + +If your PR is not a bug fix or small-scope improvement, include a link to the approved [feedback item](https://yaak.app/feedback) where contribution approval was explicitly stated. + +## Development Setup + +For local setup and development workflows, see [`DEVELOPMENT.md`](DEVELOPMENT.md). diff --git a/README.md b/README.md index 8c0713b7..7eda35a7 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,10 @@ Built with [Tauri](https://tauri.app), Rust, and React, it’s fast, lightweight ## Contribution Policy -Yaak is open source but only accepting contributions for bug fixes. To get started, -visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment. +> [!IMPORTANT] +> Community PRs are currently limited to bug fixes and small-scope improvements. +> If your PR is out of scope, link an approved feedback item from [yaak.app/feedback](https://yaak.app/feedback). +> See [`CONTRIBUTING.md`](CONTRIBUTING.md) for policy details and [`DEVELOPMENT.md`](DEVELOPMENT.md) for local setup. ## Useful Resources