Skip to content

Conversation

kmahar
Copy link
Contributor

@kmahar kmahar commented Aug 21, 2020

Open to any suggestions for wording improvements. Since this relates to version control specifically it seemed like a good fit as a sub-bullet but happy to move it to another section as well.

* General
* Has relevance to Swift on Server specifically
* Publicly accessible source managed by an SCM such as github.com or similar
* Prefer to use `main` as the default branch name, in line with [Swift itself](https://forums.swift.org/t/moving-default-branch-to-main/38515) and all SSWG-owned repos
Copy link
Contributor

Choose a reason for hiding this comment

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

indent intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

since it's related to SCM use I thought it made sense here

Copy link
Contributor

Choose a reason for hiding this comment

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

The phrasing of SSWG-owned sounds a bit weird to me, seems like a new term?

I know what you mean and it's kind of right but the phrasing feels a bit off: Is it really that SSWG "owns" repos? Maybe we can use stronger language and only refer to the swift guidelines to emphasise the point?

I would not want to create the impression that in order to "be a valuable project in SSWG ecosystem I somehow have to let go of ownership" etc, which sometimes I feel it seems like to people, while we're just a collection of projects, owned by various people, who try to keep a same style and standard of quality etc.

Suggested change
* Prefer to use `main` as the default branch name, in line with [Swift itself](https://forums.swift.org/t/moving-default-branch-to-main/38515) and all SSWG-owned repos
* Use `main` as the default branch name, in line with [Swift's guidelines](https://forums.swift.org/t/moving-default-branch-to-main/38515)

wdyt?

Copy link
Contributor Author

@kmahar kmahar Aug 24, 2020

Choose a reason for hiding this comment

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

sgtm to remove that wording, was mainly just trying to communicate that SSWG has/will do this for all of the repos under the swift-server org - but I think Swift's guidelines are enough to reference on their own.

there was some some discussion around whether we should require this, and if so what impact that would have on existing repos in the incubation process, and I think the consensus was that it should be encouraged but not required.

another wording related note I thought of over the weekend; some people may already use something that is not main but is also not master as their main branch name (trunk, development, etc.) which accomplishes a lot of what we are trying to do here (we do lose the benefit of consistency across repos, but IMO that's less important)

Copy link
Contributor

Choose a reason for hiding this comment

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

imo recommending is a sufficiently strong guidelines in the context of incubation process. on the SSWG meeting we also discussed proposing a change to Swift's code of conduct that rejects such language more strongly beyond just branch name

orthogonally, we decided to change all repositories on swift-server org to use main

Copy link
Contributor Author

Choose a reason for hiding this comment

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

propose we update to this to keep it a recommendation but also address @ktoso's concern

Suggested change
* Prefer to use `main` as the default branch name, in line with [Swift itself](https://forums.swift.org/t/moving-default-branch-to-main/38515) and all SSWG-owned repos
* Prefer to use `main` as the default branch name, in line with [Swift's guidelines](https://forums.swift.org/t/moving-default-branch-to-main/38515)

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good :) Thanks!

Copy link
Contributor

@tomerd tomerd left a comment

Choose a reason for hiding this comment

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

lgtm

@kmahar
Copy link
Contributor Author

kmahar commented Aug 21, 2020

Should I merge this or do we want any more members to review first?

@tomerd
Copy link
Contributor

tomerd commented Aug 21, 2020

@kmahar changes requires supermajority vote: https://github.com/swift-server/sswg/blob/main/process/incubation.md#change-management

@tomerd
Copy link
Contributor

tomerd commented Aug 21, 2020

cc @swift-server/sswg

@tomerd tomerd requested a review from a team August 21, 2020 22:07
Copy link
Contributor

@ktoso ktoso left a comment

Choose a reason for hiding this comment

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

LGTM, wondering about specific wording but not a blocker 👍

@kmahar kmahar merged commit 58b957b into main Sep 2, 2020
@kmahar kmahar deleted the terminology-branch-names branch September 2, 2020 17:05
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.

6 participants