Add docs, licensing, and contribution guide#3
Merged
Conversation
Document the per-crate TOML layout, how to build and consume `build/all.json`, the inclusion criteria, and the dataset's origin in crates.io.
Licensed under `MIT OR Apache-2.0`, matching the Rust ecosystem convention and crates.io, the source of the dataset. The README links to both license files.
Move the inclusion policy out of the README into CONTRIBUTING.md, next to the contribution mechanics and the maintainer notice-and-comment step. The README now links there.
Name the crates.io team as maintainer and note that external consumers are welcome while the data and format may still change, per the Rust crate ownership policy.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 fleshes out the repo's documentation now that the data and build are in place. The README grows from a one-line stub into sections covering the per-crate TOML format, how to build and consume
build/all.json, and where the data came from.The repo is dual licensed under
MIT OR Apache-2.0, matching the Rust ecosystem and crates.io, where the dataset originated.The inclusion policy moves into a new
CONTRIBUTING.md, alongside the contribution mechanics and the maintainer notice-and-comment step, so the README can simply point at it.Finally, the README gains a crate ownership notice per the Rust crate ownership policy, naming the crates.io team as maintainer and flagging that the data and format may still change while external consumers are welcome.