exercism/8th
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add notes about contributing (#114)

Browse Source
This commit is contained in:
Glenn Jackman
2024-01-05 07:36:28 -05:00
committed by GitHub
parent 1176bfbd94
commit 4e9ae857fc
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -2,9 +2,18 @@
[![configlet](https://github.com/exercism/8th/workflows/configlet/badge.svg)](https://github.com/exercism/8th/actions?query=workflow%3Aconfiglet) [![tests](https://github.com/exercism/8th/workflows/test/badge.svg)](https://github.com/exercism/8th/actions?query=workflow%3Atest)
Exercism exercises in 8th.
Exercism exercises in [8th](https://8th-dev.com/manual.html).
## Testing
## CONTRIBUTING
### Caution: CI will fail for PRs coming from forked repos
This track [uses its own test runner for CI](https://github.com/exercism/8th/blob/1176bfbd9457f51556c77b8cc26408d718d1b4d6/.github/workflows/test.yml#L18).
This requires a secret token to grant access.
I'm not sure how this mechanism works, but it means that, for PRs originating from _a fork of this repo_, access cannot be granted and CI will fail: CI will only pass for PRs merging an exercism/8th branch.
Thus only people in [the exercism/8th team](https://github.com/orgs/exercism/teams/8th) (i.e. those with write access to this repo) can successfully create a branch, submit a PR, and have CI pass.
### Testing
To test the exercises, run `./bin/test`.
This command will iterate over all exercises and check to see if their exemplar/example implementation passes all the tests.