Issue #73 resolved : Added CONTRIBUTING.md file #78
Conversation
Added CONTRIBUTING.md file
WalkthroughA new Changes
Assessment against linked issues
Poem
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: 0
🧹 Nitpick comments (7)
CONTRIBUTING.md (7)
18-24: Add anupstreamremote step for smoother syncsMany new contributors forget to keep their fork in sync with the main repository. A quick step right after cloning prevents painful re-base surprises later.
git clone https://github.com/<your-username>/InPactAI.git cd InPactAI git checkout -b feature/your-feature-name +# Add the main repo as upstream to easily pull future updates +git remote add upstream https://github.com/AOSSIE-Org/InPactAI.git
32-36: Specify the required Node versionProjects built with Vite often rely on recent Node features. Stating the minimum supported Node (e.g.,
>=18) avoids the “works on my machine” trap and saves newcomers troubleshooting time.
60-66: Make virtual-env activation cross-platform
source venv/bin/activatefails on Windows. A short note covering both shells keeps Windows contributors unblocked.source venv/bin/activate # macOS / Linux +# On Windows (PowerShell): +# .\venv\Scripts\Activate.ps1
70-73: Prefer the moderndocker composeCLIDocker Compose v2 bundles with the Docker CLI; the dashed form is now legacy. Switching prevents “command not found” on fresh Docker installs.
-docker-compose up --build +docker compose up --build
78-78: Wrap bare URLs to satisfy markdown-lintEnclosing the URLs in angle brackets or back-ticks silences MD034 and renders consistently across Markdown viewers.
-> ℹ️ Default ports: Frontend & Landing Page → http://localhost:5173, Backend → http://localhost:8000 +> ℹ️ Default ports: Frontend & Landing Page → <http://localhost:5173>, Backend → <http://localhost:8000>
101-108: Remove the colon after “like” to fix grammarLanguageTool flags the colon that follows a preposition. Dropping it keeps the sentence correct and still readable.
- - Use meaningful branch names like: + - Use meaningful branch names like ... - - Commit messages should follow conventions like: + - Commit messages should follow conventions like
101-108: Consider linking to the Conventional Commits specYou’re already nudging contributors toward
feat:/fix:prefixes. Linking the official spec (https://www.conventionalcommits.org/) clarifies the full grammar and edge cases.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[typographical] ~101-~101: Do not use a colon (:) before a series that is introduced by a preposition (‘like’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...idelines - Use meaningful branch names like: - feature/add-authentication - fix/...
(RP_COLON)
[typographical] ~105-~105: Do not use a colon (:) before a series that is introduced by a preposition (‘like’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...mmit messages should follow conventions like: - feat: added reset password function...
(RP_COLON)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
78-78: Bare URL used
null
(MD034, no-bare-urls)
78-78: Bare URL used
null
(MD034, no-bare-urls)
📦 Added
CONTRIBUTING.mdfileCloses #73
📝 Description
This pull request adds a complete
CONTRIBUTING.mdfile to the InPactAI repository.The file provides detailed instructions on:
🔧 Changes Made
CONTRIBUTING.mdwith:📷 Screenshots or Visual Changes
Not applicable — Markdown file only
🤝 Collaboration
Collaborated with:
@Aditya30ag✅ Checklist
Summary by CodeRabbit