mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2025-12-19 06:30:10 +08:00
1f0fd8215a
* docs: update PR template and README with feature PR restrictions Add temporary hold notice for Redux/IndexedDB feature PRs in both pull request template and README Fix whitespace and formatting inconsistencies in README * docs: update contributing guidelines with temporary PR restrictions Add important notice about temporary restrictions on data-changing feature PRs Clarify acceptable contribution types during v2.0.0 development phase * docs: remove warning about feature PR restrictions The warning about temporary restrictions on feature PRs involving Redux or IndexedDB changes has been removed as it is no longer relevant * docs: remove core developer membership section from contributing guides
67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
<!-- Template from https://github.com/kubevirt/kubevirt/blob/main/.github/PULL_REQUEST_TEMPLATE.md?-->
|
|
<!-- Thanks for sending a pull request! Here are some tips for you:
|
|
1. Consider creating this PR as draft: https://github.com/CherryHQ/cherry-studio/blob/main/CONTRIBUTING.md
|
|
-->
|
|
|
|
<!--
|
|
|
|
⚠️ Important: Redux/IndexedDB Data-Changing Feature PRs Temporarily On Hold ⚠️
|
|
|
|
Please note: For our current development cycle, we are not accepting feature Pull Requests that introduce changes to Redux data models or IndexedDB schemas.
|
|
|
|
While we value your contributions, PRs of this nature will be blocked without merge. We welcome all other contributions (bug fixes, perf enhancements, docs, etc.). Thank you!
|
|
|
|
Once version 2.0.0 is released, we will resume reviewing feature PRs.
|
|
|
|
-->
|
|
|
|
### What this PR does
|
|
|
|
Before this PR:
|
|
|
|
After this PR:
|
|
|
|
<!-- (optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*: -->
|
|
|
|
Fixes #
|
|
|
|
### Why we need it and why it was done in this way
|
|
|
|
The following tradeoffs were made:
|
|
|
|
The following alternatives were considered:
|
|
|
|
Links to places where the discussion took place: <!-- optional: slack, other GH issue, mailinglist, ... -->
|
|
|
|
### Breaking changes
|
|
|
|
<!-- optional -->
|
|
|
|
If this PR introduces breaking changes, please describe the changes and the impact on users.
|
|
|
|
### Special notes for your reviewer
|
|
|
|
<!-- optional -->
|
|
|
|
### Checklist
|
|
|
|
This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
|
|
Approvers are expected to review this list.
|
|
|
|
- [ ] PR: The PR description is expressive enough and will help future contributors
|
|
- [ ] Code: [Write code that humans can understand](https://en.wikiquote.org/wiki/Martin_Fowler#code-for-humans) and [Keep it simple](https://en.wikipedia.org/wiki/KISS_principle)
|
|
- [ ] Refactor: You have [left the code cleaner than you found it (Boy Scout Rule)](https://learning.oreilly.com/library/view/97-things-every/9780596809515/ch08.html)
|
|
- [ ] Upgrade: Impact of this change on upgrade flows was considered and addressed if required
|
|
- [ ] Documentation: A [user-guide update](https://docs.cherry-ai.com) was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature.
|
|
|
|
### Release note
|
|
|
|
<!-- Write your release note:
|
|
1. Enter your extended release note in the below block. If the PR requires additional action from users switching to the new release, include the string "action required".
|
|
2. If no release note is required, just write "NONE".
|
|
-->
|
|
|
|
```release-note
|
|
|
|
```
|