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.

Sign up for GitHub

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

Jump to bottom

Update contributing guide to use 3.0 branches #12829

Open
wants to merge 1 commit into
base: 3.0-dev
Choose a base branch
from
Open

Update contributing guide to use 3.0 branches #12829

wants to merge 1 commit into from

Conversation

rlmenge
Copy link
Contributor

@rlmenge rlmenge commented Mar 5, 2025 •
edited
Loading

Merge Checklist

All boxes should be checked before merging the PR (just tick any boxes which don't apply to this PR)

  • The toolchain has been rebuilt successfully (or no changes were made to it)
  • The toolchain/worker package manifests are up-to-date
  • Any updated packages successfully build (or no packages were changed)
  • Packages depending on static components modified in this PR (Golang, *-static subpackages, etc.) have had their Release tag incremented.
  • Package tests (%check section) have been verified with RUN_CHECK=y for existing SPEC files, or added to new SPEC files
  • All package sources are available
  • cgmanifest files are up-to-date and sorted (./cgmanifest.json, ./toolkit/scripts/toolchain/cgmanifest.json, .github/workflows/cgmanifest.json)
  • LICENSE-MAP files are up-to-date (./LICENSES-AND-NOTICES/SPECS/data/licenses.json, ./LICENSES-AND-NOTICES/SPECS/LICENSES-MAP.md, ./LICENSES-AND-NOTICES/SPECS/LICENSE-EXCEPTIONS.PHOTON)
  • All source files have up-to-date hashes in the *.signatures.json files
  • sudo make go-tidy-all and sudo make go-test-coverage pass
  • Documentation has been updated to match any changes to the build system
  • Ready to merge
Summary

The contributing guide was missing 3.0 branches and included refrences to 1.0 branches which is deprecated. Therefore, update to include 3.0 and remove 1.0 development branches.

Change Log
  • Update contributing guide to use 3.0 branches
Does this affect the toolchain?

NO

Test Methodology
  • Pipeline build id: xxxx

@rlmenge rlmenge requested a review from a team as a code owner March 5, 2025 17:40
@microsoft-github-policy-service microsoft-github-policy-service bot added the 3.0-dev PRs Destined for AzureLinux 3.0 label Mar 5, 2025
reubeno
reubeno reviewed Mar 5, 2025
View reviewed changes
CONTRIBUTING.md
@@ -95,25 +95,25 @@ We welcome documentation improvements. See [toolkit/docs](toolkit/docs) for the

## Pull Request Guidelines

Please direct pull requests to the desired development branch. Development changes to `2.0` should target `main`. Development changes to `1.0` should target `1.0-dev`.
Please direct pull requests to the desired development branch. Development changes to `3.0` should target `3.0-dev`. Development changes to `2.0` should target `main`. `1.0` is deprecated and should not be used.

### Branch structure

An overview of how the branches are structured can be seen below

| Branch / Tag | For PRs | Published | Notes
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for updating the doc! While you're in there...

...what do you think about adding a new column that actually indicates which of these refs are tags and which are branches?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reubeno reubeno reubeno left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
3.0-dev PRs Destined for AzureLinux 3.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rlmenge @reubeno