mirror of
https://github.com/jorenn92/Maintainerr.git
synced 2026-02-07 00:45:47 +01:00
chore: Update pull request template and contributing guidelines to clarify AI tool usage and design alignment (#2246)
This commit is contained in:
31
.github/pull_request_template.md
vendored
31
.github/pull_request_template.md
vendored
@@ -1,18 +1,37 @@
|
||||
### Description
|
||||
> **Note to contributors:**
|
||||
> This template is part of our review process. Pull requests that do not meaningfully complete the sections below, or that do not demonstrate understanding of the change, may be closed without detailed review.
|
||||
|
||||
Please include a short description of the change and the reasoning behind the approach you have chosen.
|
||||
### Description & Design
|
||||
|
||||
Please include:
|
||||
|
||||
- What problem this change solves
|
||||
- Why this approach was chosen
|
||||
- How the solution works at a high level
|
||||
- Any important trade-offs, edge cases, or limitations
|
||||
|
||||
### Related issue
|
||||
|
||||
If this pull request addresses an issue, please link to it here (e.g., `Fixes #123`).
|
||||
|
||||
### AI-Assisted Development
|
||||
|
||||
If you used AI tools (e.g. ChatGPT, Copilot, Claude) while working on this PR, please describe:
|
||||
|
||||
- Which parts were AI-assisted
|
||||
- What you personally reviewed, changed, or validated
|
||||
- Why this solution fits this project’s coding standards and design
|
||||
|
||||
> Note: The author is fully responsible for the correctness, testing, and maintainability of this change, regardless of tooling used.
|
||||
|
||||
### Checklist
|
||||
|
||||
- [ ] I have read the [CONTRIBUTING.md](CONTRIBUTING.md) document.
|
||||
- [ ] I have performed a self-review of my code.
|
||||
- [ ] I have linted and formatted my code.
|
||||
- [ ] My changes generate no new warnings.
|
||||
- [ ] New and existing unit tests pass locally with my changes.
|
||||
- [ ] I understand the code I am submitting and can explain how it works
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] I have linted and formatted my code
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
|
||||
### How to test
|
||||
|
||||
|
||||
@@ -116,7 +116,7 @@ If you prefer to set up your development environment manually (specific to a Win
|
||||
### Contributing Code
|
||||
|
||||
- If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/Maintainerr/Maintainerr/issues) to avoid multiple people working on the same thing.
|
||||
- If you have a major change or large feature to contribute, reach out via [Discussions](https://github.com/Maintainerr/Maintainerr/discussions) or our [Discord server](https://discord.gg/WP4ZW2QYwk) first to align with us! It'll save us all time, as the review will be quicker, and we will have more context about your change, allowing us to guide you in the right direction.
|
||||
- If you have a major change or large feature to contribute, reach out via [Discussions](https://github.com/Maintainerr/Maintainerr/discussions) or our [Discord server](https://discord.gg/WP4ZW2QYwk) first to align on design and approach! It'll save us all time, as the review will be quicker, and we will have more context about your change, allowing us to guide you in the right direction.
|
||||
- You can create a "draft" pull request early to get feedback on your work.
|
||||
- Large PRs (>500 lines changed, excluding tests) should be split into smaller, manageable parts by stacking your PRs sequentially. This approach makes the review process significantly easier when done in order.
|
||||
- Each PR should target one major meaningful change, which allows us to review independent changes separately, rather than having everything blocked on a single review.
|
||||
@@ -128,6 +128,20 @@ If you prefer to set up your development environment manually (specific to a Win
|
||||
- It is your responsibility to keep your branch up-to-date. Your work will **not** be merged unless it is rebased off the latest `main` branch.
|
||||
- Your code **must** be formatted correctly.
|
||||
- We use Prettier to format our code base. It is recommended to have the Prettier extension installed in your editor and to format on save. Alternatively, you can run `yarn format` to format.
|
||||
- Contributors should be prepared to explain their design decisions and trade-offs during review.
|
||||
|
||||
## Use of AI Tools
|
||||
|
||||
We allow the use of AI tools (e.g. ChatGPT, GitHub Copilot, Claude) as development aids, but not as a substitute for understanding.
|
||||
|
||||
By submitting a pull request, you confirm that:
|
||||
|
||||
- You understand the code you are submitting and can explain how it works
|
||||
- You have reviewed any AI-assisted output for correctness, security, performance, and maintainability
|
||||
- You have tested the change appropriately in the context of Maintainerr
|
||||
- You take full responsibility for the contribution, regardless of how it was produced
|
||||
|
||||
Pull requests that appear to be largely unreviewed, low-effort, or misaligned with Maintainerr’s design and coding standards may be closed without detailed feedback.
|
||||
|
||||
### UI Text Style
|
||||
|
||||
|
||||
Reference in New Issue
Block a user