github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-23 22:17:19 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9172 from GabyCT/topic/docpradvice

Browse Source 
docs: Update Code PR advice document
This commit is contained in:
GabyCT 2024-02-28 13:37:28 -06:00 committed by GitHub
commit aacbbde35d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/code-pr-advice.md
View File

@ -171,8 +171,7 @@ allows you to think about what types of value to test.
### Other categories of test ### Other categories of test
Raised a GitHub issue in the Raised a GitHub issue in the Kata Containers repository that
[`tests`](https://github.com/kata-containers/tests) repository that
explains what sort of test is required along with as much detail as explains what sort of test is required along with as much detail as
possible. Ensure the original issue is referenced on the `tests` issue. possible. Ensure the original issue is referenced on the `tests` issue.
@ -229,13 +228,13 @@ maintenance issue.
### Markdown syntax ### Markdown syntax
Run the Run the
[markdown checker](https://github.com/kata-containers/tests/tree/main/cmd/check-markdown) [markdown checker](https://github.com/kata-containers/kata-containers/tree/main/tests/cmd/check-markdown)
on your documentation changes. on your documentation changes.
### Spell check ### Spell check
Run the Run the
[spell checker](https://github.com/kata-containers/tests/tree/main/cmd/check-spelling) [spell checker](https://github.com/kata-containers/kata-containers/tree/main/tests/cmd/check-spelling)
on your documentation changes. on your documentation changes.
## Finally ## Finally