Skip to content

Document better that it's OK to use CI for testing #866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 of 3 tasks
jyn514 opened this issue Sep 9, 2020 · 2 comments
Open
1 of 3 tasks

Document better that it's OK to use CI for testing #866

jyn514 opened this issue Sep 9, 2020 · 2 comments
Labels
A-contributor-onboarding Area: contributor on-boarding advice (e.g. for new contributors) C-enhancement Category: enhancement E-easy Difficulty: might be a good place for a beginner T-compiler Relevant to compiler team

Comments

@jyn514
Copy link
Member

jyn514 commented Sep 9, 2020

Currently this is documented as

If your machine is not very powerful, a common strategy is to only use ./x.py check on your local machine and let the CI build test your changes when you push to a PR branch.

But it's hidden all the way down in https://rustc-dev-guide.rust-lang.org/building/prerequisites.html#hardware, which is a long way away from https://rustc-dev-guide.rust-lang.org/contributing.html#pull-requests (which is itself not easy to find).

We should

  • Add a note near the 'pull request' section that Rust has plenty of CI capacity for PRs and it's fine to use it
  • Make the pull request section easier to find
  • Link to it from more places

For context, this is meant to be a replacement for rust-lang/rust#76272.

@jyn514 jyn514 added the E-easy Difficulty: might be a good place for a beginner label Sep 9, 2020
@LeSeulArtichaut LeSeulArtichaut self-assigned this Sep 9, 2020
@LeSeulArtichaut LeSeulArtichaut removed their assignment May 19, 2021
@ehuss
Copy link
Contributor

ehuss commented Jan 18, 2022

There is now a dedicated chapter for this at https://rustc-dev-guide.rust-lang.org/tests/ci.html.
However, I didn't add links to it from the other places.

@jieyouxu jieyouxu added C-enhancement Category: enhancement A-contributor-onboarding Area: contributor on-boarding advice (e.g. for new contributors) T-compiler Relevant to compiler team labels Nov 2, 2024
@jieyouxu
Copy link
Member

jieyouxu commented Nov 2, 2024

Triage: we should still link to CI testing from contribution workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-contributor-onboarding Area: contributor on-boarding advice (e.g. for new contributors) C-enhancement Category: enhancement E-easy Difficulty: might be a good place for a beginner T-compiler Relevant to compiler team
Projects
None yet
Development

No branches or pull requests

4 participants