docs.rs
docs.rs copied to clipboard
rust-lang
Add a changelog
We've been merging a lot of features lately and it would be nice to have something I could throw at https://this-week-in-rust.org.
We can start recording features from when the changelog is added to avoid too much pain. It would be a good first contribution to go back through the history and find when features were first added, but we shouldn't block on that.
Mentoring instructions: create a file called CHANGELOG.md following the format in https://keepachangelog.com/en/1.1.0/. Feel free to add as many or as few past features as you have time for. There is a list of merged PRs at https://github.com/rust-lang/docs.rs/pulls?q=is%3Apr+is%3Aclosed. Docs.rs doesn't have releases, so one possible way to organize this is by date, since deploys are not tracked in a central location.
Please comment here if you start working on this so we don't have multiple people working on it at the same time.
I'd kinda prefer to have a "This month in docs.rs" blog post on Inside Rust periodically: it'll get picked up by TWIR too, but it's also easier to share around :)
Part of my hope is that this will make it easier to write the TWIR post by having the links in one place. Currently I have to go through all the PRs for the week, instead of having them added as they're made.
If we make the PRs to TWIR directly there's also the risk they just ignore the PR, which, since it's a weekly publication, means the changes won't ever be seen: https://github.com/emberian/this-week-in-rust/pull/1434. This issue is actually mostly in response to that PR, so that the record of changes will be under our control.
Is someone working on this? Or is it up for grabs? I think this would be a fantastic issue to get to know the project and its features :D
@jyn514 I'd be happy to work on this! Nothing is more interesting than to dig into some git history 😉