Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: reflect actual policy about Committers' rights #14267

Merged
merged 4 commits into from
Jul 25, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,27 @@ Before creating an issue, please check the following:
> **Warning**
> Do not close issues that are about to be resolved. It should remain open until a commit that actually resolves it is merged.

## Before implementation

### Recommended discussing before implementation
We welcome your purposal.

When you want to add a feature or fix a bug, **first have the design and policy reviewed in an Issue** (if it is not there, please make one). Without this step, there is a high possibility that the PR will not be merged even if it is implemented.

At this point, you also need to clarify the goals of the PR you will create, and make sure that the other members of the team are aware of them.
PRs that do not have a clear set of do's and don'ts tend to be bloated and difficult to review.

Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask another member to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.
Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask Commiter to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.

To the Commiters: you should not assign someone on it before the Final Desicion.
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved

### How issues are triaged

The Commiters may:
* close issue that is not reproducible on latest stable release,
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved
* merge issue into another issue,
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved
* or split issue into multiple ones
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved

@syuilo reserves Final Desicion rights including whether the project will implement feature and how to implement, but not always exercised.
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved

## Well-known branches
- **`master`** branch is tracking the latest release and used for production purposes.
Expand All @@ -39,7 +53,7 @@ Thank you for your PR! Before creating a PR, please check the following:
- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
- `fix` / `refactor` / `feat` / `enhance` / `perf` / `chore` etc
- Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
- If there is an Issue which will be resolved by this PR, please tie issues in the text.
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved
- Please add the summary of the changes to [`CHANGELOG.md`](/CHANGELOG.md). However, this is not necessary for changes that do not affect the users, such as refactoring.
- Check if there are any documents that need to be created or updated due to this change.
- If you have added a feature or fixed a bug, please add a test case if possible.
Expand Down