Blog post: How to review crates for best practices #519
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
PhilReedData
approved these changes
Jan 7, 2026
Contributor
PhilReedData
left a comment
PhilReedData
left a comment
There was a problem hiding this comment.
Good read, very useful. I like the semi-instructional format. I made one small suggestion about npm.
|
|
||
| The next step is to ensure that the RO-Crate is usable by humans. My preferred way of doing this is to explore an HTML preview of the crate. | ||
|
|
||
| Some crates already come with an `ro-crate-preview.html` file - opening this file in the browser provides an explorable rendering of the crate metadata. For those that don't include it, the file can be easily generated using the `ro-crate-html` package. |
Contributor
There was a problem hiding this comment.
Should the ro-crate-html package be a link instead of code text, to help explain the npm command in the example?
Contributor
Author
There was a problem hiding this comment.
it should indeed, thanks
Contributor
|
Really nice 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Inspired by a few crate reviews I did recently, I thought I'd write up my process