Context
The documented development process should make the test-first workflow explicit for feature and bug work.
Contributors should be guided to define the expected behavior as tests before implementing the functionality, then use the pull request checks as the visible feedback loop.
Current State
The process does not clearly require contributors to first build the tests, open a pull request, inspect the pull request CI results, and confirm the new tests fail before implementing the functionality.
This can make it harder to demonstrate that a change is driven by a failing test and that the implementation is what makes the test pass.
Objective
Update the development-process documentation so the expected workflow is clear:
- Build or update the tests that describe the desired behavior.
- Open the pull request with those tests.
- Inspect the pull request CI/check results and confirm the relevant tests fail for the expected reason.
- Implement the functionality required to make those tests pass.
- Re-run the checks and verify the pull request is green.
Tasks
Benefits
- Encourages behavior-driven and test-first changes.
- Makes the purpose of new tests visible in pull request history and checks.
- Helps reviewers distinguish test coverage from implementation fixes.
- Reduces the risk of implementing behavior without proving the test would have failed first.
Acceptance Criteria
Related
- Requested from PSModule/Yaml development workflow discussion.
Context
The documented development process should make the test-first workflow explicit for feature and bug work.
Contributors should be guided to define the expected behavior as tests before implementing the functionality, then use the pull request checks as the visible feedback loop.
Current State
The process does not clearly require contributors to first build the tests, open a pull request, inspect the pull request CI results, and confirm the new tests fail before implementing the functionality.
This can make it harder to demonstrate that a change is driven by a failing test and that the implementation is what makes the test pass.
Objective
Update the development-process documentation so the expected workflow is clear:
Tasks
Benefits
Acceptance Criteria
Related