Contributing workflow on PR size and review process expectation - #113
Open
Jerry-Jinfeng-Guo wants to merge 1 commit into
Open
Contributing workflow on PR size and review process expectation#113Jerry-Jinfeng-Guo wants to merge 1 commit into
Jerry-Jinfeng-Guo wants to merge 1 commit into
Conversation
Signed-off-by: Jerry Jinfeng Guo <jerry.jinfeng.guo@alliander.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the contributor guidance by clarifying expectations around PR size/scope and describing the project’s review criteria and workflow, with emphasis on maintainability and reviewer efficiency.
Changes:
- Adds a new “Contribution Workflow” section describing PR sizing guidelines and review criteria.
- Moves PR-size/bulk-change guidance into the AI-assisted contribution quality checklist.
- Documents how maintainers approach functionality vs. style-only adjustments and how “critical components” changes should be coordinated.
Suppressed comments (2)
CONTRIBUTING.md:272
- This list item wraps onto a new line, but the continuation line isn’t indented, which breaks Markdown list formatting (it will render as a separate paragraph).
* **Stylistic Adjustments**: If your coding style or standards differ from the rest of the codebase,
we may merge the core functionality first and initiate follow-up PRs or discussions to handle code formatting.
CONTRIBUTING.md:276
- This list item wraps onto a new line, but the continuation line isn’t indented, which breaks Markdown list formatting.
* **Maintainer Notification**: For changes to critical features or core components,
we require a heads-up and prior discussion with the maintainers.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+259
to
+262
| * **Prefer Smaller PRs**: We highly appreciate contributions that come in a manageable size. | ||
| * **Break Up Large Changes**: If your contribution involves substantial code changes, | ||
| please split it into multiple smaller, logical Pull Requests. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.