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

Where to log breaking changes for Master releases #231

Open
JorySchossau opened this issue May 28, 2018 · 1 comment
Open

Where to log breaking changes for Master releases #231

JorySchossau opened this issue May 28, 2018 · 1 comment

Comments

@JorySchossau
Copy link
Member

This is a reminder for us to discuss at the next meeting.

@JorySchossau
Copy link
Member Author

We decided in the weekly meeting:

  • Master releases will have a public relations step where we create a "blog post" describing a handful of showcased new features and describe them, a paragraph or more each. Then a slightly cleaned up trimmed list of changes from the commit history (of feature pull requests).
  • Breaking changes were defined as those that if a user were to paste in their module from the previous version of Master, would
    • cause compiler error
    • cause a runtime error/crash
    • cause unexpected behavior change, such as interpreting a loaded genome differently
  • breaking changes Pull Requests should be given the Breaking label, and described briefly in the PR description.

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

1 participant