Update SDK-PR-guide.md to include inter-branch codeflow #47420
Conversation
This file contains 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
Member
marcpopMSFT
commented
Mar 10, 2025
marcpopMSFT
commented
- Include links to the flow yml, config, and actions.
- Include comment about failed actions and PR updates
- Include 0 size PRs
- Include merge commit
dotnet-issue-labeler
bot
added
Area-Infrastructure
untriaged
There was a problem hiding this comment.
PR Overview
This PR updates the SDK PR guide to include instructions and links related to the inter-branch codeflow process.
- Introduces a new "Inter-branch codeflow" section with links to configuration files.
- Provides guidelines on handling failed workflow automation and PR merge methods.
- Explains considerations for PRs with zero changes due to automated version bumps.
Reviewed Changes
| File | Description |
|---|---|
| documentation/project-docs/SDK-PR-guide.md | Adds new documentation for inter-branch codeflow and merge practices |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
The rich preview isn't showing the 'important' note well enough, so here's what it looks like. Maybe a warning instead? |
baronfel
approved these changes
Mar 10, 2025
edvilme
reviewed
Mar 10, 2025
| ### Reviewing and merging inter-branch codeflow | ||
| Generally we will check the commit list and scan the changes for anything out of the ordinary. We take a special look for any conflict merges that were done in getting the PR building. | ||
| > [!Important] | ||
| > Make sure to create a merge commit. Do not squash. If you squash, the next inter-branch PR will list all of the same commits. |
There was a problem hiding this comment.
Suggested change
| > Make sure to create a merge commit. Do not squash. If you squash, the next inter-branch PR will list all of the same commits. | |
| > Make sure to create a merge commit. *Do not squash*. If you squash, the next inter-branch PR will list all of the same commits. |
Just in case (?)
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.