status-im/sourcecred
2
0
Fork 0
mirror of https://github.com/status-im/sourcecred.git synced 2025-01-11 21:24:35 +00:00
Code Issues Projects Releases Wiki Activity

docs: add note about full test suite credentials (#1524)

Browse Source 
Summary:
Contributors who open PRs from a fork will need to have their commits
“blessed” by a core team member before the `test-full` CI job will run
successfully. This commit explains that to ward off any confusion.

Test Plan:
This workflow was recently exercised for #1521, successfully.

wchargin-branch: contributing-test-full
This commit is contained in:
William Chargin 2020-01-05 11:18:54 -08:00 committed by GitHub
parent b860f31a19
commit cdb360f6f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -277,6 +277,20 @@ Please be aware that, as a rule, we do not create merge commits. If you
have a stack of commits, we can either rebase the stack onto master
(preserving the history) or squash the stack into a single commit.
### Running full tests on CI
As soon as you open your pull request, our CI will start running the
basic test suite (`yarn test --ci`). It will also try to run the full
test suite (`yarn test --ci --full`), but this will fail for PRs created
from forks because it depends on credentials that aren’t exposed to
untrusted PRs by default. This is expected—don’t worry!
Once a core team member sanity-checks your PR to make sure that it’s not
accidentally leaking credentials into logs, they can “bless” your commit
by pushing it to any branch on the main SourceCred repository. This will
restart the full test suite, which will now actually run. Once your
tests pass and the PR is approved, we’ll delete the extra branch.
## After your pull request is merged
…you’re done! :-)