-
Notifications
You must be signed in to change notification settings - Fork 1
Add process for proposals #96
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -14,11 +14,72 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio | |||||
|
|
||||||
| ## How to Contribute | ||||||
|
|
||||||
| 1. Fork the repository | ||||||
| 2. Create a feature branch (`git checkout -b my-feature`) | ||||||
| 3. Make your changes | ||||||
| 4. Run tests and ensure the build passes | ||||||
| 5. Submit a pull request | ||||||
| This repository accepts pull requests, but not every type of change should start as a pull request. | ||||||
|
|
||||||
| ### Changes That Usually Do Not Need Prior Approval | ||||||
|
|
||||||
| Small, scoped pull requests are generally welcome without prior discussion when they: | ||||||
|
|
||||||
| - Fix a clear bug | ||||||
| - Correct typos, broken links, or other documentation issues | ||||||
| - Add or improve tests for existing behavior | ||||||
| - Make low-risk maintenance changes that do not change product direction, architecture, or user experience | ||||||
|
|
||||||
| These changes should still be focused, easy to review, and aligned with the existing codebase. | ||||||
|
|
||||||
| ### Changes That Require Prior Approval | ||||||
|
|
||||||
| Please do not open a pull request first for changes such as: | ||||||
|
|
||||||
| - New features or user-visible capabilities | ||||||
| - Large refactors or architectural changes | ||||||
| - Changes to public behavior, workflows, or UI patterns | ||||||
| - Significant dependency changes | ||||||
| - Broad performance, telemetry, or security-related changes that affect product direction | ||||||
|
|
||||||
| These kinds of changes need review and guidance from the Microsoft team responsible for the product roadmap and design direction. | ||||||
|
|
||||||
| ### Proposal First for Larger Changes | ||||||
|
|
||||||
| If you want to propose a new feature or substantial change, start a GitHub Discussion in the `Ideas` category instead of opening a pull request immediately. | ||||||
|
|
||||||
| Your proposal should briefly cover: | ||||||
|
|
||||||
| - The problem you are trying to solve | ||||||
| - Why the current behavior is insufficient | ||||||
| - The user impact and expected benefit | ||||||
| - A rough implementation approach, if relevant | ||||||
| - Alternatives you considered | ||||||
|
|
||||||
| When you believe the discussion is ready for formal consideration, add the `design review` label. That label means a design review is requested. It does not mean the proposal has been approved. | ||||||
|
|
||||||
| The team may: | ||||||
|
|
||||||
| - Approve the proposal | ||||||
| - Decline the proposal | ||||||
| - Request changes to the scope or design | ||||||
| - Meet with the author to refine the design | ||||||
| - Decide to implement it internally | ||||||
| - Mark it as open for a community contribution | ||||||
|
|
||||||
| When a design is under review a corresponding issue will be opened for it that will track the proposal's progress. | ||||||
|
||||||
| When a design is under review a corresponding issue will be opened for it that will track the proposal's progress. | |
| When a design is under review, a corresponding issue will be opened for it that will track the proposal's progress. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub Discussions typically don’t support labels the same way Issues/PRs do (and contributors often can’t apply labels even where labels exist). Consider changing this to an actionable, platform-supported step (e.g., ‘comment to request design review’, ‘use a title prefix like [Design Review]’, or ‘open/convert to an issue and the team will apply the design review label’). The current instruction is likely not executable by contributors.