@@ -26,7 +26,7 @@ reviews:
2626 [Pure BASH Bible](https://github.com/dylanaraps/pure-bash-bible) standards.
2727 - Consider [CEP-5](https://gist.github.com/reactive-firewall/3d2bd3cf37f87974df6f7bee31a05a89)
2828 custom locking conventions.
29- - Verify all **BASH** files (e.g. are of MIME-type 'text/x-shellscript') start with an
29+ - Verify all **BASH** files (e.g., are of MIME-type 'text/x-shellscript') start with an
3030 [extensive disclaimer](https://gist.github.com/reactive-firewall/866b42d175ae3ebefcb2a5878b30ea17).
3131
3232 # Documentation Review Instructions
@@ -41,7 +41,7 @@ reviews:
4141 # Test Code Review Instructions
4242 - Ensure that test code is automated, comprehensive, and follows testing best practices.
4343 - Verify that all critical functionality is covered by tests.
44- - Verify that minimal acceptance tests (e.g. those run by the workflow CI-MATs) are passing and
44+ - Verify that minimal acceptance tests (e.g., those run by the workflow CI-MATs) are passing and
4545 error free, pointing out any failure as below minimal acceptance (i.e. un-acceptable).
4646 - Ensure that the test coverage meets or exceeds the project's required threshold
4747 (e.g., aiming for 100% coverage as per Issue #53).
@@ -56,7 +56,7 @@ reviews:
5656 a BSD License, the Unlicence, the Apache v2 License, or that the dependency is optional. Do
5757 not assume a dependency is optional, confirm if it is or is not optional.
5858 - For **Python** code, consider [PEP 290](https://peps.python.org/pep-0290/) whenever a python
59- (e.g. has the extension '.py') file is changed.
59+ (e.g., has the extension '.py') file is changed.
6060 request_changes_workflow : true
6161 high_level_summary : true
6262 high_level_summary_placeholder : ' @coderabbitai summary'
@@ -167,7 +167,7 @@ reviews:
167167 4. Consider these 'requirements.txt' files the records of truth regarding project
168168 dependencies.
169169 5. Consider the 'requirements.txt' file in the base of the git repository
170- (e.g. './requirements.txt') the required python dependencies regarding Multicast project
170+ (e.g., './requirements.txt') the required python dependencies regarding Multicast project
171171 dependencies.
172172 - path : tests/requirements.txt
173173 instructions : >-
@@ -192,7 +192,7 @@ reviews:
192192 1. Consider the files in the `docs/` directory tree the core/main/in-depth documentation
193193 of the project. Also consider the 'docs/**.md' files the second place to look for
194194 project documentation after the 'README.md' file.
195- 2. When reviewing the documentation files (e.g. `docs/**.md`), they should additionally
195+ 2. When reviewing the documentation files (e.g., `docs/**.md`), they should additionally
196196 be linted with help from the tool `markdownlint`, pointing out any issues.
197197 3. When reviewing the documentation files in `docs/` directory, they should additionally
198198 be linted with help from the tool `languagetool`, pointing out any issues.
0 commit comments