You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation with new test requirements and planning improvements
- Added requirement to run and pass all tests before committing in `build.md` with guidance on crafting commit messages.
- Enhanced `plan.md` with a task to organize hook tests into separate files for better maintainability.
Copy file name to clipboardExpand all lines: docs/build.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,5 +9,6 @@ For each task, use the following workflow - execute each in order and show the r
9
9
* run the relevant code to ensure it works as expected
10
10
* run the application without any arguments and correct any errors and warnings you find iteratively until it works without error. Also, ensure running the test suite returns without errors or warnings.
11
11
* run the application with the "run" argument and correct any errors and warnings you find iteratively until it works without error.
12
-
* commit and push all files
12
+
* run all tests and correct any errors and warnings you find iteratively until all tests pass.
13
+
* commit and push all files - craft a good commit message.
Copy file name to clipboardExpand all lines: docs/plan.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,3 +67,4 @@ Tasks:
67
67
-[ ] Lets remove the `rh` executable and rename it to `rustyhook` - we will use a shell alias to make `rustyhook` available as `rh`. We can add that alias as part of the installation process - perhaps in the completion scripts.
68
68
-[ ] emulate all known pre-commit hooks for use with native execution - all known hooks at https://github.com/pre-commit/pre-commit-hooks
69
69
-[ ] Add code coverage to the project and emit statistics on the coverage of the tests. Ideally the output should be in a format that can be used by codecov.io
70
+
-[ ] Break up the hook tests into individual files per hook test - this should help adding more as it will keep things very tidy upon changes.
0 commit comments