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

[Markdown] Contributing: Add section about release branch PRs #688

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AnthonyLatsis
Copy link
Contributor

@AnthonyLatsis AnthonyLatsis commented Jun 4, 2024

Motivation:

In an effort to centralize information about the release process, including guidance on formatting a release branch pull request, dedicate a section to this for repositories and forum announcements to refer to.

Modifications:

Result:

@AnthonyLatsis
Copy link
Contributor Author

cc @shahmishal.

@@ -111,6 +111,55 @@ For C or C++ source or header files, the code header should look this:

The divider lines should be exactly 80 characters wide to aid in adherence to the code style guidelines. The bottom section contains an optional description intended for generated documentation (these lines begin with `///` rather than `//`). If there is no description, this area can be skipped.

### Release Branch Pull Requests

*All changes* to a release branch (`release/x.y`) must be nominated through pull
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's a nomination in this instance? Does it mean that you have to suggest your code for inclusion in a different forum before a PR can be opened or would

Suggested change
*All changes* to a release branch (`release/x.y`) must be nominated through pull
*All changes* to a release branch (`release/x.y`) must be done through pull

Be a better description

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nominated in the sense of proposed, but I’m happy to use "done" if you think it’s more apt. Let me have another go at rewording this to be crystal clear.

contributing/_contributing-code.md Outdated Show resolved Hide resolved
contributing/_contributing-code.md Outdated Show resolved Hide resolved
Comment on lines 139 to 140
- **Reviewers**: The code owners that approved the mainline branch pull
requests. If any part of the mainline branch changes was not approved by a
respective code owner, provide a reason. Technical review can be delegated
by a code owner or otherwise requested as deemed appropriate or useful.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second sentence amended per swiftlang/swift#72722 (comment). I would really like to add some clarity to that last sentence too, but that can wait.

@AnthonyLatsis AnthonyLatsis requested a review from 0xTim June 5, 2024 21:23
@AnthonyLatsis AnthonyLatsis force-pushed the prunus-persica branch 2 times, most recently from b7c3c4f to 62421ad Compare June 6, 2024 19:09
Copy link
Contributor

@finagolfin finagolfin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, only single suggestion.

@AnthonyLatsis
Copy link
Contributor Author

Small change of plans: the form now lives in swiftlang/.github as a pull request template, so no need to inline it here.

In an effort to centralize information about the release process,
including guidance on formatting a release branch pull request, dedicate
a section to this for repositories and forum announcements to refer to.
@AnthonyLatsis
Copy link
Contributor Author

Friendly ping, fellows.

@cthielen cthielen removed their request for review July 6, 2024 02:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants