Updated the CONTRIBUTING.md Testing section to cover jest and vitest #3277
Conversation
WalkthroughThe pull request updates the Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
CONTRIBUTING.md (3)
Line range hint
103-141: Add language specifiers to code blocks for proper syntax highlighting.The Jest testing section is well-documented, but the code blocks should specify the language for proper syntax highlighting and markdown compliance.
Apply these changes to the code blocks:
-``` +```bash npm run test path/to/test/file-
+bash
npm run test --watchAll=false-``` +```bash npm run test --watchAll=false --coverage /path/to/test/file-
+bash
npm run test --watchAll=false --coverage🧰 Tools
🪛 Markdownlint (0.37.0)
107-107: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
113-113: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
119-119: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
125-125: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
133-133: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
142-165: Add language specifiers to Vitest code blocks.The Vitest testing section is well-structured, but needs language specifiers for the code blocks.
Apply these changes:
-``` +```bash npm run test:vitest /path/to/test/file-
+bash
npm run test:vitest-``` +```bash npm run test:vitest:coverage /path/to/test/file-
+bash
npm run test:vitest:coverage🧰 Tools
🪛 Markdownlint (0.37.0)
145-145: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
151-151: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
163-163: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
168-180: Add language specifiers to combined testing code blocks.The combined testing section provides valuable information but needs language specifiers for the code blocks.
Apply these changes:
-``` +```bash npm run test && npm run test:vitest-
+bash
npm run test --watchAll=false --coverage && npm run test:vitest:coverage🧰 Tools
🪛 Markdownlint (0.37.0)
172-172: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-178: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
107-107: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
113-113: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
119-119: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
145-145: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
151-151: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
163-163: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
172-172: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
178-178: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
CONTRIBUTING.md
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (2)
CONTRIBUTING.md (2)
20-21: LGTM! Well-structured TOC additions.The new testing sections are logically placed under the "Contributing Code" section.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
Line range hint
1-181: Add required label for protected file modification.The PR is attempting to modify a protected file (CONTRIBUTING.md). To proceed:
- The PR needs the 'ignore-sensitive-files-pr' label
- Request a maintainer to add this label to allow modifications to protected files
✅ Verification successful
Protected file modification requires authorization label
The review comment is accurate. CONTRIBUTING.md is explicitly listed as a protected file in the repository's workflow configuration. Changes to this file require the 'ignore-sensitive-files-pr' label, which is currently not present on the PR.
To proceed:
- Request a maintainer to add the 'ignore-sensitive-files-pr' label to authorize the modification
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify if the PR has the required label gh pr view 3277 --json labels -q '.labels[].name' | grep 'ignore-sensitive-files-pr' || echo "Required label missing"Length of output: 139
Script:
#!/bin/bash # Check for any file protection patterns in the repository fd -H "protect|sensitive" -t f --max-depth 2 | while read -r file; do echo "=== $file ===" head -n 20 "$file" done # Also check if there's a GitHub workflow that enforces this fd "sensitive|protect" .github/workflows/ | while read -r file; do echo "=== $file ===" cat "$file" doneLength of output: 120
Script:
#!/bin/bash # List and examine all workflow files echo "=== Workflow Files ===" fd . .github/workflows/ -e yml -e yaml -x cat {}Length of output: 32674
🧰 Tools
🪛 Markdownlint (0.37.0)
145-145: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
151-151: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
163-163: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
172-172: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-178: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
CONTRIBUTING.md (1)
Line range hint
1-155: Add required label for protected file modification.The pipeline is failing because CONTRIBUTING.md is a protected file that requires the 'ignore-sensitive-files-pr' label for modifications.
Please add the 'ignore-sensitive-files-pr' label to this PR to allow modifications to this protected file.
🧰 Tools
🪛 Markdownlint (0.37.0)
106-106: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
114-114: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
118-118: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
123-123: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
132-132: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
136-136: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
140-140: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
144-144: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
149-149: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
153-153: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
🧹 Nitpick comments (3)
CONTRIBUTING.md (3)
104-129: Add language specifications to code blocks and improve formatting.The Jest Testing section content is accurate, but the code blocks need language specifications for better syntax highlighting and markdown compliance.
Apply these changes:
- ``` + ```bash npm run test path/to/test/file ``` - ``` + ```bash npm run test --watchAll=false ``` - ``` + ```bash npm run test --watchAll=false --coverage /path/to/test/file ``` - ``` + ```bash npm run test --watchAll=false --coverage ``` - ``` + ```bash npm run jest-preview npm run test --watchAll=false --coverage ```🧰 Tools
🪛 Markdownlint (0.37.0)
106-106: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
114-114: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
118-118: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
123-123: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
130-146: Add language specifications to Vitest code blocks.Similar to the Jest section, add language specifications to the code blocks.
Apply these changes:
- ``` + ```bash npm run test:vitest /path/to/test/file ``` - ``` + ```bash npm run test:vitest ``` - ``` + ```bash npm run test:vitest:coverage /path/to/test/file ``` - ``` + ```bash npm run test:vitest:coverage ```🧰 Tools
🪛 Markdownlint (0.37.0)
132-132: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
136-136: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
140-140: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
144-144: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
147-155: Add language specifications to Combined testing code blocks.Add language specifications to maintain consistency across all code blocks.
Apply these changes:
- ``` + ```bash npm run test && npm run test:vitest ``` - ``` + ```bash npm run test --watchAll=false --coverage && npm run test:vitest:coverage ```🧰 Tools
🪛 Markdownlint (0.37.0)
149-149: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
153-153: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
106-106: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
110-110: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
114-114: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
118-118: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
123-123: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
132-132: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
136-136: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
140-140: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
144-144: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
149-149: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
153-153: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
CONTRIBUTING.md
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
20-22: LGTM! Table of Contents updated correctly.The new testing sections are properly added to the TOC structure.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
palisadoes
added
the
ignore-sensitive-files-pr
|
Please fix the failing test. Markdown filled will need to be excluded from linting |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3277 +/- ##
=====================================================
+ Coverage 8.56% 89.96% +81.40%
=====================================================
Files 309 330 +21
Lines 7954 8519 +565
Branches 1763 1884 +121
=====================================================
+ Hits 681 7664 +6983
+ Misses 7196 601 -6595
- Partials 77 254 +177
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
@aadhil2k4 also add the section for testing the entire repo. |
The combined tests part is for testing the entire repo. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
CONTRIBUTING.md (3)
101-104: Fix heading format and address trailing colon.The content clearly explains the test coverage requirements, but the heading format needs adjustment.
- 1. ### General: + 1. ### General🧰 Tools
🪛 Markdownlint (0.37.0)
101-101: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
106-159: Add language specifications to code blocks and fix heading format.The testing commands are well-documented, but the markdown formatting needs improvement:
- Add language specifications to code blocks (e.g.,
bashorshell)- Remove trailing colon from heading
Example fix for code blocks:
-``` +```bash npm run test path/to/test/fileAnd for heading: ```diff - 2. ### Testing: + 2. ### Testing🧰 Tools
🪛 Markdownlint (0.37.0)
106-106: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
109-109: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
113-113: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
117-117: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
121-121: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
126-126: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
135-135: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
139-139: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
143-143: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
153-153: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
161-186: Fix formatting issues and update macOS reference.The test coverage documentation is comprehensive, but needs the following improvements:
- Remove trailing colon from heading
- Add language specifications to code blocks
- Update "MacOS" to "macOS" for correct branding
Example fixes:
- #### Test Code Coverage: + #### Test Code Coverage -``` +```bash npm install-packages can be found for Windows and MacOS.
+packages can be found for Windows and macOS.<details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [grammar] ~173-~173: The operating system from Apple is written “macOS”. Context: ...r packages can be found for Windows and MacOS. - The currently acceptable co... (MAC_OS) </details> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 161-161: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 166-166: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 177-177: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 181-181: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d0aa741460dbd5cbe4c7d17b6bc783e9d07cd44b and 361017ca57c1e3d6f5c26596994af35ff56a05f1. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `CONTRIBUTING.md` (2 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>CONTRIBUTING.md</summary> [grammar] ~173-~173: The operating system from Apple is written “macOS”. Context: ...r packages can be found for Windows and MacOS. - The currently acceptable co... (MAC_OS) </details> </details> <details> <summary>🪛 Markdownlint (0.37.0)</summary> <details> <summary>CONTRIBUTING.md</summary> 101-101: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 106-106: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 161-161: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 109-109: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 113-113: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 117-117: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 121-121: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 126-126: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 135-135: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 139-139: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 143-143: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 147-147: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 153-153: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 157-157: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 166-166: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 177-177: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 181-181: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms (2)</summary> * GitHub Check: Test Application * GitHub Check: Analyse Code With CodeQL (javascript) </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>CONTRIBUTING.md (2)</summary> `20-25`: **LGTM! Table of Contents is well-structured.** The new testing sections are properly organized in the table of contents. --- Line range hint `1-186`: **Consider excluding markdown files from linting.** Based on the PR comments, tests are failing due to markdown linting issues. Consider adding `.md` files to `.eslintignore` to resolve these failures. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [grammar] ~173-~173: The operating system from Apple is written “macOS”. Context: ...r packages can be found for Windows and MacOS. - The currently acceptable co... (MAC_OS) </details> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 101-101: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 106-106: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 161-161: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 109-109: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 113-113: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 117-117: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 121-121: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 126-126: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 135-135: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 139-139: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 143-143: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 147-147: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 153-153: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 157-157: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 166-166: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 177-177: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 181-181: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
|
@palisadoes I have added screenshots of the previews. 
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
CONTRIBUTING.md (4)
109-134: Improve code block formatting.
- Add language specifiers to all code blocks
- Fix indentation to match document structure
- Consider adding descriptions for each command
Example fix:
- ``` + ```bash npm run test path/to/test/file<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 109-109: null Headings must start at the beginning of the line (MD023, heading-start-left) --- 111-111: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 115-115: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 119-119: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 123-123: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 128-128: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `153-161`: **Maintain consistent formatting with previous sections.** 1. Fix heading indentation 2. Add language specifiers to code blocks 3. Consider adding explanatory text about when to use combined testing <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 153-153: null Headings must start at the beginning of the line (MD023, heading-start-left) --- 155-155: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 159-159: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `175-175`: **Fix macOS spelling.** Correct the spelling of Apple's operating system. ```diff -The `genhtml` command is part of the Linux `lcov` package. Similar packages can be found for Windows and MacOS. +The `genhtml` command is part of the Linux `lcov` package. Similar packages can be found for Windows and macOS.🧰 Tools
🪛 LanguageTool
[grammar] ~175-~175: The operating system from Apple is written “macOS”.
Context: ...r packages can be found for Windows and MacOS. - The currently acceptable co...(MAC_OS)
188-188: Improve image references.
- Use consistent image naming (avoid spaces and special characters)
- Add alt text that describes the image content
- Consider using relative paths consistently
Example:
-.jpg>) +
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[grammar] ~175-~175: The operating system from Apple is written “macOS”.
Context: ...r packages can be found for Windows and MacOS. - The currently acceptable co...
(MAC_OS)
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
109-109: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
135-135: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
153-153: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
163-163: null
Headings must start at the beginning of the line
(MD023, heading-start-left)
101-101: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
106-106: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
163-163: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
111-111: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
115-115: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
119-119: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
123-123: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
137-137: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
141-141: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
145-145: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
149-149: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
159-159: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
168-168: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
179-179: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
183-183: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Check Python Code Style
- GitHub Check: Test Application
- GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (3)
CONTRIBUTING.md (3)
101-104: Fix section formatting.The heading and content need to be adjusted:
- Remove the colon from the heading
- Move the heading to the left margin
- ### General: +### General - - We need to get to 100% test coverage for the app. We periodically increase the desired test coverage for our pull requests to meet this goal. - - Pull requests that don't meet the minimum test coverage levels will not be accepted. This may mean that you will have to create tests for code you did not write. You can decide which part of the code base needs additional tests if this happens to you. +- We need to get to 100% test coverage for the app. We periodically increase the desired test coverage for our pull requests to meet this goal. +- Pull requests that don't meet the minimum test coverage levels will not be accepted. This may mean that you will have to create tests for code you did not write. You can decide which part of the code base needs additional tests if this happens to you.🧰 Tools
🪛 Markdownlint (0.37.0)
101-101: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
106-108: Fix section formatting.The heading needs to be adjusted:
- Remove the colon
- Move to the left margin
- ### Testing: +### Testing🧰 Tools
🪛 Markdownlint (0.37.0)
106-106: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
135-151: Apply the same formatting fixes as Jest section.The same improvements are needed here:
- Add language specifiers to code blocks
- Fix indentation
🧰 Tools
🪛 Markdownlint (0.37.0)
135-135: null
Headings must start at the beginning of the line(MD023, heading-start-left)
137-137: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
141-141: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
145-145: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
149-149: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
palisadoes
merged commit 7e650f9
into
PalisadoesFoundation:develop-postgres
What kind of change does this PR introduce?
Documentation
Issue Number:
Fixes #3270
If relevant, did you update the documentation?
Yes
Does this PR introduce a breaking change?
No
Checklist
CodeRabbit AI Review
Test Coverage
Have you read the contributing guide?
Yes
Summary by CodeRabbit
.eslintignoreto exclude markdown files from linting.