rust-lang / rust-lang/docs.rs

[meta] add more tests

Open
#551 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-builds C-technical-debt P-high
Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

Most of these are partially addressed in https://github.com/rust-lang/docs.rs/pull/524https://github.com/rust-lang/docs.rs/pull/524, but it would be better to have unit tests.

Off the top of my head:

  • proc macros should work (but only for default target because of bugs in cargo)
  • all targets are built
  • anything that's not only bin is built, including cdylib, rlib, etc.
  • viewing source works (#570 )
  • building with docker-compose from scratch (no cache) works (expensive, doesn't need to be run on every commit)
    • including on hosts other than x86_64-unknown-linux-gnu
  • renamed crates work (e.g. constellation-rs -> constellation)
  • 'go to latest version' works and doesn't crash (#570 )
  • A default-target other than the host builds successfully and is uploaded to the database as the default target

This would make me much more comfortable fixing https://github.com/rust-lang/docs.rs/issues/544 and https://github.com/rust-lang/docs.rs/issues/459.

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

Start by reviewing PR 524 and the existing unit-test setup for docs.rs. Use the listed cases as the test scope, including proc macros, all targets, renamed crates, Docker Compose builds, and non-host default targets. Done means the remaining unchecked behaviors have regression tests, while the cases marked complete remain covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, rust
Domain
devops, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.