rust-lang / rust-lang/rustc-dev-guide

Rework the test directives page

Open
#2,187 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-compiletest A-test-suite I-confusing I-outdated T-bootstrap T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

The directives page is quite confusing and probably needs a rework:

  • The listing has inconsistent formatting, making it tricky to follow.
  • Might need to revisit how to present some of the information.
  • Some directive info are outdated, incomplete and/or inaccurate.

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 locating the test directives page in the rustc-dev-guide and compare its listing and directive descriptions with the current compiler tests or other referenced sources. Review the formatting, presentation, and directive information; done means the page is consistent, complete, and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.