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

How do we make breaking changes immediately visible #65

Closed
surchs opened this issue Nov 13, 2023 · 2 comments
Closed

How do we make breaking changes immediately visible #65

surchs opened this issue Nov 13, 2023 · 2 comments
Labels
flag:discuss Flag issue that needs to be discussed before it can be implemented. flag:schedule Flag issue that should go on the roadmap or backlog. _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again

Comments

@surchs
Copy link
Contributor

surchs commented Nov 13, 2023

We use semver (and once goes in, this will be meaningful). We are in "initial development" which is defined as

Anything MAY change at any time. The public API SHOULD NOT be considered stable.

That's accurate, but maybe not very convenient for users. So we should discuss how we want to highlight meaningful breaking changes. Or if we want to soon move to a major version release and leave the development space.

@surchs surchs added the flag:discuss Flag issue that needs to be discussed before it can be implemented. label Nov 13, 2023
Copy link

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

  • prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
  • close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
  • archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
    apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
    label in the future. Use sparingly!

@github-actions github-actions bot added the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Jan 28, 2024
@alyssadai alyssadai added the flag:schedule Flag issue that should go on the roadmap or backlog. label Feb 28, 2024
@alyssadai
Copy link
Contributor

Now that we have our auto-release process set up, we can achieve this using our pr-minor-breaking and pr-major-breaking release labels (see also our template .autorc here). These should automatically organize breaking change PRs under a dedicated section in the changelog.

@github-project-automation github-project-automation bot moved this to Review - Done in Neurobagel Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag:discuss Flag issue that needs to be discussed before it can be implemented. flag:schedule Flag issue that should go on the roadmap or backlog. _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again
Projects
Archived in project
Development

No branches or pull requests

2 participants