Improve contributing docs #9732
Open
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
giordano
reviewed
Nov 4, 2024
giordano
reviewed
Nov 4, 2024
README.md
Outdated
| To contribute a new recipe, you can either | ||
| For detailed information about contributing, go to ["CONTRIBUTING.md"](https://github.com/JuliaPackaging/Yggdrasil/blob/master/CONTRIBUTING.md). For a quick overview, continue reading. | ||
|
|
||
| To update the version to build for an existing recipe, simply open a PR to this repository making the required tweaks. This usually boils down to only updating the version number and the source (e.g., URL and hash for an archive, or the revision for a git repository) of the relevant `build_tarballs.jl` file, but in some cases more changes may be needed. For an example, see [this PR](https://github.com/JuliaPackaging/Yggdrasil/pull/8833). The version number should be easy to find, and the URL + hash can be found by clicking the release, clicking the final commit in the release, and copying the information from the URL bar. |
There was a problem hiding this comment.
The instructions to find the commit hash are specific to github though, which isn't the only web hosting service in the world.
There was a problem hiding this comment.
Right, but it is all I know. This should cover many (most?) cases and is therefore useful as-is, and more examples are ofc very welcome.
There was a problem hiding this comment.
Still, this sounds as if it's a generic recommendation, which is not.
fingolfin
reviewed
Nov 17, 2024
Co-authored-by: Max Horn <[email protected]>
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.
This PR adds a link to the CONTRIBUTING file in the readme.
It also moves the information on updating an existing release to the top. This is because it was really easy to do, and putting the easy stuff first help ensuring that people who want to do the easy stuff do not stop/quit at the hard stuff.
This PR also and removes the separate section for it, as the slightly smaller heading in markdown is usually not sufficient to signal that it is a subsection. Also, there is just a single paragraph of instructions, so a new heading was overkill.