fix: Clarify Contribution Guide for Code Changes#10
Merged
SaschaSchwarze0 merged 1 commit intoshipwright-io:mainfrom Apr 9, 2025
Merged
fix: Clarify Contribution Guide for Code Changes#10SaschaSchwarze0 merged 1 commit intoshipwright-io:mainfrom
SaschaSchwarze0 merged 1 commit intoshipwright-io:mainfrom
Conversation
pull-request-size
bot
added
the
size/S
openshift-ci
bot
added
the
kind/documentation
Updating the contribution guide address a few process changes that were introduced in 2024: - The "community" repo should be used as a fallback repository for bug reports or feature requests. - Make explicit that code changes should merge to the `main` branch first. We have always used the trunk-based approach for development - it wasn't until SHIP-0038 was adopted that we actually had release branches to maintain [1]. - Provide specific instructions on how to add the DCO sign-off footer to commit messages. - Add link on how to submit a pull request on GitHub. This may not be intuitive, especially for non-technical contributors. [1] https://github.com/shipwright-io/community/blob/main/ships/0038-release-branching-backports.md Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
adambkaplan
force-pushed
the
clarify-main-first
branch
from
b51bd7f to
02450e5
Compare
Member
Author
|
cc @qu1queee @SaschaSchwarze0 - a new contributor asked me which branch code changes to merge to, since we now have release branches in our main repos. |
SaschaSchwarze0
approved these changes
Apr 9, 2025
Member
SaschaSchwarze0
left a comment
SaschaSchwarze0
left a comment
There was a problem hiding this comment.
Thanks.
/approve
/lgtm
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
2 participants
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.
Changes
Updating the contribution guide address a few process changes that were introduced in 2024:
mainbranch first. We have always used the trunk-based approach for development - it wasn't until SHIP-0038 was adopted that we actually had release branches to maintain [1].[1] https://github.com/shipwright-io/community/blob/main/ships/0038-release-branching-backports.md
/kind documentation
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes