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

Add PR template to require PR authors to include necessary JSON Schema updates #102

Closed
cholmes opened this issue May 23, 2022 · 4 comments
Closed
Assignees
Milestone

Comments

@cholmes
Copy link
Member

cholmes commented May 23, 2022

With #64 we are now saying that the JSON schema file is a core part of the spec, so we should ensure that any PR that changes behavior always updates both the spec and the schema file. I think the easiest way to do this is a just a checkbox nudge on any PR, to help us remember, though I'm open to other ideas.

I suppose that in turn will force us to update examples, but that seems like a good thing.

@brendan-ward
Copy link
Contributor

PR process question re: #104: when a contributor updates the spec, should they also update the version number in various places as part of that PR? On the one hand, it seems that the version isn't bumped until ratified by approving PRs (of which there may be multiple incremental updates to the spec prior to the next minor version), but on the other it seems like extra work to bump that later like in #104.

@kylebarron
Copy link
Collaborator

No strong preference, but I think it's fine to bump the version number later. It's a small PR to bump it.

@cholmes
Copy link
Member Author

cholmes commented May 25, 2022

I lean towards bumping on release. I want to try to write up a 'release process' document like https://github.com/radiantearth/stac-spec/blob/master/process.md#release-process just to have a check-list to make sure we do everything.

I think it could be nice to have a 'version release PR' - like where we do the version bumps in the readme, spec, examples & scripts all in one PR. And then ideally that PR would need approval by some high percentage of 'core contributors' as a vote that 'this is ready for release'. Release process would be merging that PR and then cutting the release.

@cholmes cholmes added this to the 1.0.0-beta.1 milestone Nov 7, 2022
@cholmes cholmes self-assigned this Nov 7, 2022
@tschaub tschaub modified the milestones: 1.0.0-beta.1, 1.0.0-beta.2 Dec 15, 2022
@cholmes cholmes modified the milestones: 1.0.0-rc.1, 1.0.1 Jul 26, 2023
@cholmes
Copy link
Member Author

cholmes commented Jun 7, 2024

I don't think we'll do this for 1.1

@cholmes cholmes closed this as completed Jun 7, 2024
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

No branches or pull requests

4 participants