Skip to content

Commit c62db7b

Browse files
committed
Add contribution policy docs and PR checklist template
1 parent 4e56daa commit c62db7b

3 files changed

Lines changed: 38 additions & 2 deletions

File tree

.github/pull_request_template.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Summary
2+
3+
<!-- Describe the bug and the fix in 1-3 sentences. -->
4+
5+
## Submission
6+
7+
- [ ] This PR is a bug fix or small-scope improvement.
8+
- [ ] If this PR is not a bug fix or small-scope improvement, I linked an approved feedback item below.
9+
- [ ] I have read and followed [`CONTRIBUTING.md`](CONTRIBUTING.md).
10+
- [ ] I tested this change locally.
11+
- [ ] I added or updated tests when reasonable.
12+
13+
Approved feedback item (required if not a bug fix or small-scope improvement):
14+
<!-- https://yaak.app/feedback/... -->
15+
16+
## Related
17+
18+
<!-- Link related issues, discussions, or feedback items. -->

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing to Yaak
2+
3+
Yaak accepts community pull requests for:
4+
5+
- Bug fixes
6+
- Small-scope improvements directly tied to existing behavior
7+
8+
Pull requests that introduce broad new features, major redesigns, or large refactors are out of scope unless explicitly approved first.
9+
10+
## Approval for Non-Bugfix Changes
11+
12+
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.
13+
14+
## Development Setup
15+
16+
For local setup and development workflows, see [`DEVELOPMENT.md`](DEVELOPMENT.md).

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,10 @@ Built with [Tauri](https://tauri.app), Rust, and React, it’s fast, lightweight
5858

5959
## Contribution Policy
6060

61-
Yaak is open source but only accepting contributions for bug fixes. To get started,
62-
visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment.
61+
> [!IMPORTANT]
62+
> Community PRs are currently limited to bug fixes and small-scope improvements.
63+
> If your PR is out of scope, link an approved feedback item from [yaak.app/feedback](https://yaak.app/feedback).
64+
> See [`CONTRIBUTING.md`](CONTRIBUTING.md) for policy details and [`DEVELOPMENT.md`](DEVELOPMENT.md) for local setup.
6365
6466
## Useful Resources
6567

0 commit comments

Comments
 (0)