Add a section on pull requests to contributing instructions #635
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview the changes: https://turinglang.org/docs/pr-previews/635 |
|
Version lag issue, causing CI failure, being fixed here: #636 |
penelopeysm
reviewed
Aug 13, 2025
|
|
||
| #### Change history | ||
|
|
||
| We keep a cumulative changelog in a file called `HISTORY.md` at the root of the repository. It should have an entry for every new breaking release, explaining everything our users need to know about the changes, such as what may have broken and how to fix things to work with the new version. Any major new features should also be described in `HISTORY.md`, as may any other changes that are useful for users to know about. Bug fixes generally don't need an entry in `HISTORY.md`. Any new breaking release must have an entry in `HISTORY.md`, entries for non-breaking releases are optional. |
There was a problem hiding this comment.
Hmmmm I've been putting changelog entries for all patch releases so far (at least for Turing / DPPL). I think it's a net benefit -- would it be too strict to enforce at least a one-liner for all releases?
Comment on lines
+83
to
+89
| ``` | ||
| @JuliaRegistrator register | ||
|
|
||
| Release notes: | ||
| [YOUR RELEASE NOTES HERE] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| ``` | |
| @JuliaRegistrator register | |
| Release notes: | |
| [YOUR RELEASE NOTES HERE] | |
| ``` | |
| ``` | |
| @JuliaRegistrator register | |
| Release notes: | |
| [YOUR RELEASE NOTES HERE] | |
| ``` | |
| If you are making a breaking release, your release notes must also contain the string `Breaking changes` somewhere in them (this is mandated by the `@JuliaRegistrator` bot, described below). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #619