Add cross-release compatibility note to CONTRIBUTING.md #17911
Merged
Conversation
This file contains 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
| However, porting a package to the latest release may cause the package to break on | ||
| earlier Julia releases. To maintain compatibility across releases, use | ||
| [`Compat.jl`](https://github.com/JuliaLang/Compat.jl/). Find the fix for your package | ||
| from the README, and tag the minimum version of Compat that provides the fix |
There was a problem hiding this comment.
tag is an overloaded word here
There was a problem hiding this comment.
Shall I use the word "specify" instead?
|
I'm not sure if this repo's CONTRIBUTING.md is the best place for info about contributing to packages. |
|
Maybe. @ViralBShah wanted a link to the Compat guide in CONTRIBUTING.md, so I wrote up this PR. Also, what is up with Travis? This error log says it can't find openblas. A couple of other PR's failed with seemingly unrelated errors too. |
tkelman
pushed a commit
that referenced
this pull request
Aug 11, 2016
* Add cross-release compatibility note to CONTRIBUTING.md * tag -> specify (cherry picked from commit dcffb4a)
|
Package authors are much more likely to look at the manual section on writing packages than at CONTRIBUTING.md, which is about contributing to Julia. Why not move these explanations there? |
|
That would make sense to me. |
|
Alright, will write up a PR for this. |
mfasi
pushed a commit
to mfasi/julia
that referenced
this pull request
Sep 5, 2016
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.
Add a note for package devs about porting their package from one release to another.
cc: @tkelman @ViralBShah