Repository navigation
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
| It's easy to introduce bugs by passing or returning inconsistent data types, and tracking down those `Undefined method for nil:NilClass` errors can be painful. Ruby contracts help to avoid these problems proactively, freeing us from writing tons of boilerplate, defensive code. (There is a performance penalty, but the nature of Entitlements does not require it to be high performance.) | ||
|
|
||
| - 100% [unit test](#unit-tests) coverage is required. | ||
| - 100% [unit test](docs/tests.md#unit-tests) coverage is required. |
There was a problem hiding this comment.
π οΈ Reach unit-test instructions: The old local fragment has no matching heading in this guide. The link now reaches the unit-test section, preserving the full-coverage requirement.
| Unit tests should stub/mock any calls to external services, which allows those tests to run quickly and easily in both local development environments and CI. | ||
|
|
||
| - [Acceptance test](#acceptance-tests) coverage is required for new and interesting functionality. | ||
| - [Acceptance test](docs/tests.md#acceptance-tests) coverage is required for new and interesting functionality. |
There was a problem hiding this comment.
π οΈ Reach acceptance-test instructions: The old local fragment does not lead to testing instructions. The link now reaches the acceptance-test section; the requirement still applies to new and interesting functionality.
| 0. [Fork][fork] and clone the repository | ||
| 0. Configure and install the dependencies: `script/bootstrap` | ||
| 0. Make sure the tests pass on your machine: `rake` | ||
| 0. Make sure the tests pass on your machine: `script/test -d` |
There was a problem hiding this comment.
π οΈ Select the maintained test runner: The old command assumes a root rake taskfile that is missing from this checkout. This runner selects lint, unit tests and coverage checking. Its -d flag skips bootstrap, which the preceding step already performs to install dependencies and generate binstubs; acceptance tests remain separate.
There was a problem hiding this comment.
π’ Approval recommended
No active review issues are identified, and the changes are limited to correcting contributor testing documentation and the supported local test command.
No open issues π
What changed in this PR
Updates contributor guidance to point to the maintained testing documentation and supported local test runner.
Changes:
- Links unit and acceptance testing requirements to
docs/tests.md. - Replaces the undefined
rakecommand withscript/test -d.
| File | Description |
|---|---|
CONTRIBUTING.md |
Corrects testing documentation links and contributor test instructions. |
Review effort: Lite (auto)
π§ How this helps Copilot
The old contributor guide could send Copilot to an undefined test command or links that do not reach the test instructions. The corrected guide points to the maintained test runner after dependency setup and to the relevant unit and acceptance testing sections.
Automated details
Source:
curate-memoriesDream, analyzingmainateca2c47.