Skip to content

Commit e606f5e

Browse files
CONTRIB: add info about workflows on forks
Ref. #1292
1 parent 4814e71 commit e606f5e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

scripts/core/CONTRIB.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,16 @@ Actions workflow and *must* be reviewed by no less than two code owners.
272272
files, leaving only conflicts in non-generated source files to be resolved,
273273
if any.
274274

275+
By default, any new fork has all GitHub Actions workflows disabled. If you would
276+
like to, e.g., test your branch using our CI workflows *before* creating
277+
a pull request, you have to enter the *Actions* tab on your fork and enable
278+
workflows for this repository. When they are not needed anymore, you can disable
279+
them again, but it has to be done one by one. The CI on the upstream repository
280+
gets busy from time to time. That's why you may want to enable workflows on your
281+
fork to get the testing results quicker. The disadvantage of the CI on your fork
282+
is that it may report some failing jobs you may not expect, and it does not run
283+
some of the jobs (due to a lack of specific hardware from self-hosted runners).
284+
275285
Core Features
276286
=============
277287

0 commit comments

Comments
 (0)