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

[OLD] use main branch instead of dev/master #268

Closed

Conversation

philvarner
Copy link
Collaborator

@philvarner philvarner commented Feb 28, 2022

Related Issue(s):

Proposed Changes:

Change branch strategy to use main w/ tags instead of dev/master.

There are two aspects to this change:

  1. Changing from using a develop->released branch model to a single branch -- Until now, the dev branch was a rapidly-changing work-in-progress. It made sense to not make this the first thing people saw when they came to this repo. As we converge towards 1.0.0, there will be fewer significant changes in main that are not part of the latest released version. Most repos don't have master or a branch with their latest released version as the default branch, so users are used to main being the development tip.
  2. Changing the name of the primary branch from master to main -- This has been a trend in the last couple years, motivated primarily by the origination and metaphorical use of the term "master" because of its use in the chattel slavery system in the United States prior to 1865. A project with a diverse audience should not use terms that are so blatantly offensive.

References:

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • This PR does not make any changes to the core spec in the stac-spec directory (these are included as a subtree and should be updated directly in radiantearth/stac-spec)
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

Copy link
Collaborator

@m-mohr m-mohr left a comment

Choose a reason for hiding this comment

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

Are there any (important) external dependencies (may just be links) that point towards master? Does this need to go through the PSC? Would we align stac-spec, too?

@philvarner
Copy link
Collaborator Author

Yes, I think it should definitely go through the PSC.

I would be in favor of aligning stac-spec too, since it's at 1.0.0 and hasn't had any changes in months.

@philvarner philvarner marked this pull request as draft March 2, 2022 13:42
@cholmes
Copy link
Collaborator

cholmes commented Mar 2, 2022

Can you write up the reasoning for this? I do think we should do the same thing for stac-spec and stac-api. I'm open to switching it, but just want to be sure I understand the reasoning, etc.

@philvarner
Copy link
Collaborator Author

I will, where should I write it up?

@m-mohr
Copy link
Collaborator

m-mohr commented Mar 3, 2022

Here for now?

@philvarner
Copy link
Collaborator Author

Are there any (important) external dependencies (may just be links) that point towards master?

I'm not aware of any. I plan to leave master around, but we can clearly indicate in the README that you should be using main or the latest release tag instead.

Does this need to go through the PSC?

I should have added the entire PSC as Reviewers -- I've done that now.

Would we align stac-spec, too?

I think we should align stac-spec with this too.

@philvarner philvarner marked this pull request as ready for review March 8, 2022 01:45
@philvarner philvarner requested a review from m-mohr March 8, 2022 01:46
@tschaub
Copy link
Collaborator

tschaub commented May 24, 2022

+1 for naming the default branch main and having the default branch be the base for development.

@cholmes
Copy link
Collaborator

cholmes commented May 24, 2022

I'm fully +1 on naming default branch to main.

I'm ok with default branch being the base for development as long as we add in a 'publish' step for release and host the 'definitive' text somewhere else, like stacspec.org/specs/stac-api or something, and have the readme say 'the latest version of the spec is at stacspec.org, this repo contains the development of unreleased versions' or something.

To me it just doesn't really work if we're doing active development on the default branch if the 'spec' is just the repo, since then people who just go to https://github.com/radiantearth/stac-api-spec/ won't know that the 'stable' thing they're supposed to look at to see the spec is actually a branch, and that the default navigation may lead to changes that have been made but are not yet 'shipped' in a spec release.

@tschaub
Copy link
Collaborator

tschaub commented May 24, 2022

Yeah, the main readme could just be an intro blurb (without deeper links) and links to more detail for the latest release.

Something like ...


STAC API

The STAC API defines a JSON-based web API to browse and query SpatioTemporal Asset Catalog (STAC) objects. While the core STAC specification provides a structure and language to describe assets, users usually want to access a subset of the entire catalog, such as for a certain date range, in a particular area of interest, or matching properties they care about. STAC API extensions specify those query parameters, and compliant servers return STAC Item objects that match the user's preferences. A lot of additional functionality can added through the OGC API family of standards, particularly OGC API - Features (OAFeat, for our shorthand).

Description Version
Latest release version v1.0.0-rc.2
Development version (unstable) main
Previous versions v1.0.0-beta.5, v1.0.0-beta.4, v1.0.0-beta.3, v1.0.0-beta.2

And the readme could contain any other links to docs where you do want people to be reading the latest (e.g. contributing, communication, stability note, maturity classification, etc.). Just avoid lots of links to versioned docs (with the exception of the version table).

@philvarner philvarner marked this pull request as draft June 21, 2022 14:30
@philvarner philvarner mentioned this pull request Jun 21, 2022
4 tasks
@philvarner philvarner changed the title use main branch instead of dev/master [OLD] use main branch instead of dev/master Jun 21, 2022
@philvarner
Copy link
Collaborator Author

I created a new PR after re-branching here #308

The merge from current dev had a lot of conflicts for so few text changes in this PR, and it is an easier migration process to create a new main branch and merge these changes into it and then switch the default branch than to merge into dev and rename it.

@philvarner philvarner closed this Jul 15, 2022
@philvarner philvarner deleted the pv/migrate-dev-to-main branch January 31, 2023 00:17
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.

4 participants