docs: enhancements in contributing guide #230
Conversation
|
No significant changes currently retry |
WalkthroughThis update restructures and expands the documentation for contributing to the project. It introduces new backend and Go installation guides, refactors the contribution index, and enhances sidebar navigation with collapsible sections. Two outdated guides are removed. Additionally, a new Changes
Sequence Diagram(s)sequenceDiagram
participant DocsPage as Documentation Page
participant CodeGroup as CodeGroup Component
participant User as User
DocsPage->>CodeGroup: Render with tabs prop
CodeGroup->>User: Display tab buttons and code block
User->>CodeGroup: Click tab button
CodeGroup->>CodeGroup: Update activeTab and display code
User->>CodeGroup: Click copy button
CodeGroup->>User: Copy code to clipboard and show feedback
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~15–20 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (8)
docs/contributing/backend/backend-architecture.md (1)
35-41: Specify language for code block and improve formatting.The code block should specify the language for proper syntax highlighting.
Apply this diff:
- ``` + ```text api/internal/features/your-feature/ ├── controller/init.go # HTTP handlers ├── service/service_name.go # Business logic ├── storage/dao_name.go # Data access └── types/type_name.go # Type definitions - ``` + ```docs/contributing/installing_go.md (1)
21-21: Minor punctuation improvement for clarity.Consider adding a comma for better readability.
Apply this diff:
-The `-L` flag follows redirects and `-O` saves the file with the original filename. +The `-L` flag follows redirects, and `-O` saves the file with the original filename.docs/contributing/backend/overview.md (2)
71-71: Add language specification to fenced code block.The markdown linter flagged that this fenced code block is missing a language specification.
-``` +```bash
34-35: Minor grammar improvements for clarity.Static analysis flagged some minor grammar issues that can improve readability.
-### Set up PostgreSQL database using Docker -This creates a containerized database that's isolated from your system +### Set up a PostgreSQL database using Docker +This creates a containerized database that's isolated from your system.docs/.vitepress/components/CodeGroup.vue (1)
61-69: Consider adding fallback for unsupported clipboard API.The clipboard API might not be available in all browsers or contexts (like non-HTTPS environments). Consider adding a fallback mechanism.
const copyCode = async () => { try { - await navigator.clipboard.writeText(getCurrentCode()) - copied.value = true - setTimeout(() => copied.value = false, 2000) + if (navigator.clipboard) { + await navigator.clipboard.writeText(getCurrentCode()) + } else { + // Fallback for older browsers + const textArea = document.createElement('textarea') + textArea.value = getCurrentCode() + document.body.appendChild(textArea) + textArea.select() + document.execCommand('copy') + document.body.removeChild(textArea) + } + copied.value = true + setTimeout(() => copied.value = false, 2000) } catch (error) { console.error('Failed to copy code:', error) } }docs/contributing/index.md (3)
131-131: Remove trailing punctuation from heading.Markdown linter flagged trailing punctuation in the heading.
-#### Step 3: Set Up PostgreSQL Database using Docker: +#### Step 3: Set Up PostgreSQL Database using Docker
195-199: Fix inconsistent list style.The list uses asterisks while the rest of the document uses dashes for unordered lists.
-* **Making Changes** - [Making Changes Guide](getting-involved/making-changes.md) -* **Testing Your Changes** - [Testing Guide](getting-involved/making-changes.md) -* **Submitting a Pull Request** - [Pull Request Guide](getting-involved/proposing-changes.md) -* **Proposing New Features** - [Feature Proposal Guide](getting-involved/proposing-changes.md) -* **Extending Documentation** - [Documentation Guide](documentation/documentation.md) +- **Making Changes** - [Making Changes Guide](getting-involved/making-changes.md) +- **Testing Your Changes** - [Testing Guide](getting-involved/making-changes.md) +- **Submitting a Pull Request** - [Pull Request Guide](getting-involved/proposing-changes.md) +- **Proposing New Features** - [Feature Proposal Guide](getting-involved/proposing-changes.md) +- **Extending Documentation** - [Documentation Guide](documentation/documentation.md)
23-27: Minor grammar improvements.Static analysis flagged some minor grammar issues that can improve clarity.
-Before diving into the step by step development setup instructions, you can choose between two setups process: -- <Badge type="tip">Automatic Setup</Badge>: A single script to install all pre-requisite dependencies, install clone the repository, configure ports, launch PSQL container, generate ssh keys and start both backend and frontend in hot reload mode. This is best for setting up repository for the first time. +Before diving into the step-by-step development setup instructions, you can choose between two setup processes: +- <Badge type="tip">Automatic Setup</Badge>: A single script to install all prerequisite dependencies, clone the repository, configure ports, launch PSQL container, generate ssh keys and start both backend and frontend in hot reload mode. This is best for setting up the repository for the first time. -- <Badge type="tip">Manual Setup</Badge>: In this setup, you will have to individually install Docker, Go, Node.js/Yarn, and Git, and clone the repository, copy and customized your .env files to spin up the database in Docker, giving granular control of your env. +- <Badge type="tip">Manual Setup</Badge>: In this setup, you will have to individually install Docker, Go, Node.js/Yarn, and Git, clone the repository, copy and customize your .env files to spin up the database in Docker, giving granular control of your environment.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
api/api/versions.json(1 hunks)docs/.vitepress/components/CodeGroup.vue(1 hunks)docs/.vitepress/config.mts(2 hunks)docs/.vitepress/theme/index.ts(2 hunks)docs/contributing/backend.md(0 hunks)docs/contributing/backend/backend-architecture.md(1 hunks)docs/contributing/backend/overview.md(1 hunks)docs/contributing/docker.md(0 hunks)docs/contributing/index.md(1 hunks)docs/contributing/installing_go.md(1 hunks)docs/contributing/self-hosting.md(0 hunks)
💤 Files with no reviewable changes (3)
- docs/contributing/backend.md
- docs/contributing/self-hosting.md
- docs/contributing/docker.md
🧰 Additional context used
🪛 LanguageTool
docs/contributing/backend/overview.md
[uncategorized] ~34-~34: You might be missing the article “a” here.
Context: ...pi/.env.sample api/.env ``` ### Set up PostgreSQL database using Docker This creates a co...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~35-~35: A period might be missing here.
Context: ...ized database that's isolated from your system ``` docker run -d \ --name nixopus-d...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[style] ~99-~99: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ver will automatically restart when you make changes to your code. ### Verify the Setup Once ...
(MAKE_CHANGES)
docs/contributing/installing_go.md
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...amd64.tar.gz ``` The -L flag follows redirects and `-O` saves the file with the origin...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~148-~148: Did you mean “to Install”?
Context: ...onfigure GOPATH and GOPROXY if needed - Install Go tools: `go install golang.org/x/tool...
(MISSING_TO_BEFORE_A_VERB)
docs/contributing/index.md
[grammar] ~23-~23: Did you mean the adjective or adverb “step-by-step” (spelled with hyphens)?
Context: ...velopment Setup Before diving into the step by step development setup instructions, you can...
(STEP_BY_STEP_HYPHEN)
[uncategorized] ~24-~24: You might be missing the article “a” here.
Context: ...eload mode. This is best for setting up repository for the first time. - <Badge type="tip...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~26-~26: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...Git, and clone the repository, copy and customized your .env files to spin up the database...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ... Prerequisites > [!IMPORTANT] > As pre-requisite install Docker & Docker Compose on your...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~37-~37: The operating system from Apple is written “macOS”.
Context: ... curl by default will be available on MacOS / Linux | Dependency ...
(MAC_OS)
[uncategorized] ~126-~126: Possible missing preposition found.
Context: ...](#environment-variables) you can refer this guide > [!NOTE] > The root `.env.sample...
(AI_EN_LECTOR_MISSING_PREPOSITION)
[uncategorized] ~169-~169: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...s.md). ## Running the Application ### Start the Backend API ```bash cd ../api && a...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
🪛 markdownlint-cli2 (0.17.2)
docs/contributing/backend/overview.md
71-71: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/contributing/backend/backend-architecture.md
35-35: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/contributing/index.md
33-33: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
51-51: Link fragments should be valid
(MD051, link-fragments)
104-104: Multiple headings with the same content
(MD024, no-duplicate-heading)
126-126: Link fragments should be valid
(MD051, link-fragments)
131-131: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
195-195: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
196-196: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
197-197: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
198-198: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
199-199: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (13)
api/api/versions.json (1)
6-6: LGTM - Timestamp update is correct.The release date timestamp update is syntactically correct and maintains the proper ISO 8601 format with timezone information.
docs/.vitepress/theme/index.ts (2)
10-10: LGTM - Import statement is correct.The import statement follows the correct syntax and path convention for local Vue components.
20-20: LGTM - Component registration follows established pattern.The global component registration for CodeGroup follows the same pattern as other components and enables reuse across documentation pages.
docs/.vitepress/config.mts (2)
55-56: LGTM - Navigation enhancement improves accessibility.Adding the "Ask" link to Discord provides users with a direct way to get help and engage with the community.
92-141: Excellent sidebar restructuring for better navigation.The hierarchical organization of the contribution section with nested collapsible groups significantly improves documentation discoverability and organization. The structure logically separates backend, frontend, documentation, and involvement guides.
docs/contributing/backend/backend-architecture.md (1)
1-184: Comprehensive and well-structured architecture guide.This document provides excellent guidance for backend contributors with clear project structure explanation, practical code examples, and step-by-step feature addition instructions. The clean architecture approach is well-documented.
docs/contributing/installing_go.md (2)
148-148: Minor grammar correction for consistency.The list item should include "to" before the verb for grammatical consistency.
Apply this diff:
-- Install Go tools: `go install golang.org/x/tools/gopls@latest` +- Install Go tools: `go install golang.org/x/tools/gopls@latest`Actually, let me reconsider - the current format is fine as a list item. The static analysis tool may be overly pedantic here.
1-149: Excellent comprehensive Go installation guide.This guide provides thorough installation instructions with multiple methods, troubleshooting steps, and next steps. It's well-structured and will be very helpful for contributors setting up their development environment.
docs/contributing/backend/overview.md (1)
1-122: Overall documentation quality is excellent.This is a comprehensive and well-structured backend setup guide. The content is detailed, includes helpful badges and tips, provides clear step-by-step instructions, and offers good context for each step. The fixture system documentation is particularly helpful for new contributors.
docs/.vitepress/components/CodeGroup.vue (2)
22-81: Well-implemented Vue 3 composition API component.The component demonstrates excellent Vue 3 patterns:
- Proper use of composition API with
defineProps,ref,computed- Good error handling for JSON parsing
- Reactive state management for active tab and copy feedback
- Proper lifecycle management with
onMounted
83-203: Excellent styling with comprehensive responsive and accessibility support.The CSS demonstrates:
- Proper use of CSS custom properties for theming
- Responsive design with mobile breakpoints
- Dark mode support
- Smooth transitions and hover effects
- Good accessibility with focus states and proper contrast
docs/contributing/index.md (2)
65-68: Excellent use of the new CodeGroup component.The integration of the new CodeGroup component for platform-specific commands enhances the documentation's usability and readability. This is a great example of how to present multiple options clearly.
1-204: Outstanding documentation restructuring effort.This transformation from a simple guide to a comprehensive contribution hub is excellent. The modular approach with specialized guides, detailed setup instructions for both automatic and manual processes, and clear navigation structure significantly improves the contributor experience.
| func NewFeatureStorage(db *bun.DB, ctx context.Context)*NewFeatureStorage { | ||
| return &FeatureStorage{ | ||
| DB: db, | ||
| Ctx: ctx | ||
| } | ||
| } |
There was a problem hiding this comment.
Fix function naming inconsistency in Go code example.
There's a naming inconsistency in the function and type names that could confuse readers.
Apply this diff to fix the inconsistency:
-func NewFeatureStorage(db *bun.DB, ctx context.Context)*NewFeatureStorage {
- return &FeatureStorage{
+func NewFeatureStorage(db *bun.DB, ctx context.Context)*FeatureStorage {
+ return &FeatureStorage{
DB: db,
Ctx: ctx
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| func NewFeatureStorage(db *bun.DB, ctx context.Context)*NewFeatureStorage { | |
| return &FeatureStorage{ | |
| DB: db, | |
| Ctx: ctx | |
| } | |
| } | |
| func NewFeatureStorage(db *bun.DB, ctx context.Context)*FeatureStorage { | |
| return &FeatureStorage{ | |
| DB: db, | |
| Ctx: ctx | |
| } | |
| } |
🤖 Prompt for AI Agents
In docs/contributing/backend/backend-architecture.md around lines 113 to 118,
the function name NewFeatureStorage does not match the returned type
FeatureStorage, causing inconsistency. Rename the function to NewFeatureStorage
to match the type or rename the returned struct to NewFeatureStorage to ensure
consistent naming between the constructor function and the struct it returns.
| - **Explore the Codebase**: Check out the [Project Structure](#project-structure) section below | ||
| - **Start the Frontend**: Follow the [Frontend Development Guide](../frontend/frontend.md) | ||
| - **Write Your First Feature**: See the [Adding a New Feature](#adding-a-new-feature) section | ||
| - **Run Tests**: Learn about [Testing](#testing) your code |
There was a problem hiding this comment.
Fix broken internal links.
The document references sections that don't exist in this file. These links will result in 404 errors.
-- **Explore the Codebase**: Check out the [Project Structure](#project-structure) section below
-- **Start the Frontend**: Follow the [Frontend Development Guide](../frontend/frontend.md)
-- **Write Your First Feature**: See the [Adding a New Feature](#adding-a-new-feature) section
-- **Run Tests**: Learn about [Testing](#testing) your code
+- **Explore the Codebase**: Check out the [Backend Architecture Guide](backend-architecture.md)
+- **Start the Frontend**: Follow the [Frontend Development Guide](../frontend.md)
+- **Write Your First Feature**: See the [Backend Architecture Guide](backend-architecture.md#adding-a-new-feature)
+- **Run Tests**: Learn about testing in the [Backend Architecture Guide](backend-architecture.md#testing)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Explore the Codebase**: Check out the [Project Structure](#project-structure) section below | |
| - **Start the Frontend**: Follow the [Frontend Development Guide](../frontend/frontend.md) | |
| - **Write Your First Feature**: See the [Adding a New Feature](#adding-a-new-feature) section | |
| - **Run Tests**: Learn about [Testing](#testing) your code | |
| - **Explore the Codebase**: Check out the [Backend Architecture Guide](backend-architecture.md) | |
| - **Start the Frontend**: Follow the [Frontend Development Guide](../frontend.md) | |
| - **Write Your First Feature**: See the [Backend Architecture Guide](backend-architecture.md#adding-a-new-feature) | |
| - **Run Tests**: Learn about testing in the [Backend Architecture Guide](backend-architecture.md#testing) |
🤖 Prompt for AI Agents
In docs/contributing/backend/overview.md around lines 119 to 122, the internal
links point to sections that do not exist in this file, causing broken links.
Update or remove these links to reference valid section headers within the
document or correct the targets to existing sections to prevent 404 errors.
|
|
||
| ```bash | ||
| createdb postgres -U postgres | ||
| #### Prerequisites |
There was a problem hiding this comment.
Fix heading level increment violation.
Markdown linter flagged that heading levels should only increment by one level at a time (h2 to h4 skips h3).
-#### Prerequisites
+### Prerequisites📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### Prerequisites | |
| ### Prerequisites |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
33-33: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🤖 Prompt for AI Agents
In docs/contributing/index.md at line 33, the heading level jumps from h2
directly to h4, which violates markdown linter rules. Adjust the heading level
at line 33 to h3 to ensure proper incremental heading levels without skipping.
| ``` | ||
| > [!CAUTION] | ||
| > Automatic setup isn’t available for Windows. This script only supports Linux and macOS. <br> | ||
| > Please refer to the [manual installation instructions](#manual-installation) for Windows. |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Fix broken link fragments.
These links reference fragments that don't exist, causing navigation failures.
Also applies to: 126-126
🏁 Script executed:
#!/bin/bash
# Description: Search for the referenced sections in the documentation
# Expected: Find if #manual-installation and #environment-variables sections exist
echo "Searching for manual-installation section:"
rg -n "manual.installation|Manual.Installation" docs/
echo -e "\nSearching for environment-variables section:"
rg -n "environment.variables|Environment.Variables" docs/Length of output: 1508
🏁 Script executed:
#!/bin/bash
# List headings in docs/contributing/index.md
echo "Headings in docs/contributing/index.md:"
rg -n '^#{1,6} ' docs/contributing/index.md
echo -e "\nHeadings in docs/contributing/installing_go.md:"
rg -n '^#{1,6} ' docs/contributing/installing_go.mdLength of output: 1443
Fix broken link anchors in docs/contributing/index.md
Both #manual-installation and #environment-variables don’t match any headings in this file. Update them to match the existing slugs:
• #### Installation command → #installation-command
• #### Step 2: Configure Environment Variables → #step-2-configure-environment-variables
Files/lines to update:
- docs/contributing/index.md:51
- docs/contributing/index.md:126
Suggested diff:
docs/contributing/index.md
- Please refer to the [manual installation instructions](#manual-installation) for Windows.
+ Please refer to the [manual installation instructions](#installation-command) for Windows.
@@ -124,7 +124,7 @@
if you want to see what each variable is for [here](#environment-variables) you can refer this guidebecomes:
-if you want to see what each variable is for [here](#environment-variables) you can refer this guide
+if you want to see what each variable is for [here](#step-2-configure-environment-variables) you can refer this guide📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > Please refer to the [manual installation instructions](#manual-installation) for Windows. | |
| docs/contributing/index.md | |
| @@ -51,1 +51,1 @@ | |
| - > Please refer to the [manual installation instructions](#manual-installation) for Windows. | |
| + > Please refer to the [manual installation instructions](#installation-command) for Windows. | |
| @@ -124,7 +124,7 @@ | |
| - if you want to see what each variable is for [here](#environment-variables) you can refer this guide | |
| + if you want to see what each variable is for [here](#step-2-configure-environment-variables) you can refer this guide |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In docs/contributing/index.md at lines 51 and 126, the link anchors
#manual-installation and #environment-variables do not match any existing
headings. Update the anchor at line 51 to #installation-command to match the
"#### Installation command" heading, and update the anchor at line 126 to
#step-2-configure-environment-variables to match the "#### Step 2: Configure
Environment Variables" heading. This will fix the broken links by aligning them
with the correct heading slugs.
…n manual setup flow inside a collapsible
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
docs/contributing/index.md (3)
33-33: Fix heading-level jump (####→###).Heading levels must increase sequentially (MD001).
Change#### Prerequisitesto### Prerequisites.-#### Prerequisites +### Prerequisites
49-52: Broken anchor#manual-installation— still unresolved.The heading slug is
#installation-command; update the link accordingly.-Please refer to the [manual installation instructions](#manual-installation) for Windows. +Please refer to the [manual installation instructions](#installation-command) for Windows.
126-126: Broken anchor#environment-variables— still unresolved.Slug should match the heading
Step 2.-if you want to see what each variable is for [here](#environment-variables) you can refer this guide +If you want to see what each variable is for [here](#step-2-configure-environment-variables) you can refer to this guide
🧹 Nitpick comments (8)
docs/contributing/index.md (8)
23-23: Hyphenate “step-by-step” & tighten wording.-Before diving into the step by step development setup instructions, you can choose between two setups process: +Before diving into the step-by-step development setup instructions, you can choose between two setup processes:
24-24: Grammar: add missing conjunction & article.-...dependencies, install clone the repository, configure ports... +...dependencies, and clone the repository, configure ports...
26-26: Verb form & wording.-...copy and customized your .env files to spin up the database in Docker, giving granular control of your env. +...copy and customize your `.env` files to spin up the database in Docker, giving you granular control over your environment.
35-37: Minor style fixes (comma + “macOS”).-As pre-requisite install Docker & Docker Compose on your machine. <br> -Given `curl` by default will be available on MacOS / Linux +As a pre-requisite, install Docker & Docker Compose on your machine. <br> +`curl` is available by default on macOS/Linux
104-104: Duplicate heading text — differentiate manual prerequisites.Two identical
#### Prerequisitesheadings violate MD024. Rename the second one for clarity.-#### Prerequisites +#### Prerequisites (Manual Setup)
131-131: Remove trailing colon in heading.MD026 flags punctuation at the end of headings.
-#### Step 3: Set Up PostgreSQL Database using Docker: +#### Step 3: Set Up PostgreSQL Database using Docker
147-148: Step numbering skips 5.The guide jumps from Step 4 to Step 6. Renumber to keep a continuous sequence (or insert the missing step).
196-200: Use dash-list style to satisfy MD004.-* **Making Changes** - [Making Changes Guide](getting-involved/making-changes.md) -* **Testing Your Changes** - [Testing Guide](getting-involved/making-changes.md) -* **Submitting a Pull Request** - [Pull Request Guide](getting-involved/proposing-changes.md) -* **Proposing New Features** - [Feature Proposal Guide](getting-involved/proposing-changes.md) -* **Extending Documentation** - [Documentation Guide](documentation/documentation.md) +- **Making Changes** – [Making Changes Guide](getting-involved/making-changes.md) +- **Testing Your Changes** – [Testing Guide](getting-involved/making-changes.md) +- **Submitting a Pull Request** – [Pull Request Guide](getting-involved/proposing-changes.md) +- **Proposing New Features** – [Feature Proposal Guide](getting-involved/proposing-changes.md) +- **Extending Documentation** – [Documentation Guide](documentation/documentation.md)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/contributing/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/contributing/index.md
[grammar] ~23-~23: Did you mean the adjective or adverb “step-by-step” (spelled with hyphens)?
Context: ...velopment Setup Before diving into the step by step development setup instructions, you can...
(STEP_BY_STEP_HYPHEN)
[uncategorized] ~24-~24: You might be missing the article “a” here.
Context: ...eload mode. This is best for setting up repository for the first time. - <Badge type="tip...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~26-~26: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...Git, and clone the repository, copy and customized your .env files to spin up the database...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ... Prerequisites > [!IMPORTANT] > As pre-requisite install Docker & Docker Compose on your...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~37-~37: The operating system from Apple is written “macOS”.
Context: ... curl by default will be available on MacOS / Linux | Dependency ...
(MAC_OS)
[uncategorized] ~126-~126: Possible missing preposition found.
Context: ...](#environment-variables) you can refer this guide > [!NOTE] > The root `.env.sample...
(AI_EN_LECTOR_MISSING_PREPOSITION)
[uncategorized] ~169-~169: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...s.md). ## Running the Application ### Start the Backend API ```bash cd ../api && a...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
🪛 markdownlint-cli2 (0.17.2)
docs/contributing/index.md
33-33: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
51-51: Link fragments should be valid
(MD051, link-fragments)
104-104: Multiple headings with the same content
(MD024, no-duplicate-heading)
126-126: Link fragments should be valid
(MD051, link-fragments)
131-131: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
196-196: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
197-197: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
198-198: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
199-199: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
200-200: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 15933525 | Triggered | Generic Password | 67e2875 | docker-compose-test.yml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Summary by CodeRabbit
New Features
Documentation