Skip to content

Commit

Permalink
docs: Add CONTRIBUTING guidelines for broken CI jobs (#11521)
Browse files Browse the repository at this point in the history
Summary:
Following up on offline discussion, adding instructions to CONTRIBUTING.md file
to instruct contributors not to ignore broken CI jobs, and create github Issues
when appropriate.

Pull Request resolved: #11521

Reviewed By: bikramSingh91

Differential Revision: D65890364

Pulled By: pedroerp

fbshipit-source-id: c90855dbecb00b4f274cd02ae61fd2dd3a1ca15b
  • Loading branch information
pedroerp authored and facebook-github-bot committed Nov 13, 2024
1 parent beada2b commit 24a36c0
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The contribution process is outlined below:

3. Start a discussion by creating a Github Issue, or asking on Slack (unless the change is trivial).
* This step helps you identify possible collaborators and reviewers.
* Does the proposed change align with technical vision and project values?
* Does the proposed change align with the technical vision and project values?
* Will the change conflict with another change in progress? If so, work with others to minimize impact.

4. Implement the change.
Expand All @@ -85,8 +85,15 @@ The contribution process is outlined below:
with the title prefixed with [WIP], and share with collaborators to get early feedback.
* Ensure the PR follows the [title and description
guidelines](#commit-messages) presented below.
* Make sure the PR passes all CI tests.
* Create/submit a Github PR and tag the reviewers identified in Step 3.
* Create/submit a Github PR and make sure it passes **all CI tests**.
* Do not ignore red CI signals, even if they seem preexisting.
* If you believe a red CI signal is unrelated to your change, please search for
existing Issues reporting this particular test. They should contain the test name
in the Issue title.
* If an Issue already exist, add a comment containing the link to your failed CI job.
* If an Issue does not exist, please create one with the title "Broken CI \<test\_name\>",
tagging the appropriate maintainers for that component.
* Once all CI signals are green, tag the reviewers identified in Step 3.

5. Review is performed by one or more reviewers.
* This normally happens within a few days, but may take longer if the change
Expand Down

0 comments on commit 24a36c0

Please sign in to comment.