rust-lang / rust-lang/docs.rs

Add a changelog

Open Beginner friendly
#1,013 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

C-technical-debt E-easy mentor P-medium
Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the Keep a Changelog 1.1.0 format linked in the issue, then review the closed pull request list for features worth recording. Create CHANGELOG.md with a date-based structure and any past features you choose to include; the work is done when the file follows the format and provides a usable record for future updates.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.