Enhancement: Add CONTRIBUTING.md to align with open-source best practices#22
Merged
kpj2006 merged 12 commits intoAOSSIE-Org:mainfrom Feb 22, 2026
Merged
Conversation
Added a CONTRIBUTING.md file to align the repository with open-source best practices. This file includes: - Contribution workflow - Branch naming guidelines - Commit message conventions - Pull request standards - Testing instructions No functional changes were introduced.
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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. Comment |
Contributor
Author
|
Hi @kpj2006, I have implemented one of the open-source best practices by adding a CONTRIBUTING.md file aligned with the template repository. PR: #22 Kindly review it and let me know if any modifications, corrections, or additional improvements are required. I’ll be happy to make the necessary updates. Thanks! |
|
@coderabbitai full review |
Contributor
✅ Actions performedFull review triggered. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
84-117: Improve formatting for push instructions and guidelines.Several formatting improvements needed:
- Line 88: Git command is a h6 heading instead of a code block
- Lines 91-99: PR contents should be formatted as a bullet list
- Lines 103-111: PR guidelines should be a bullet list
- Lines 115-116: Using h4 headings for emphasis on regular text
📋 Proposed improvements
### 6️⃣ Push and Open a Pull Request Push your branch: -###### git push origin feature/your-feature-name - +```bash +git push origin feature/your-feature-name +``` Then open a Pull Request including: -What changes were made - -Why the change is needed - -Screenshots (if UI changes) - -Any relevant issue reference +- What changes were made +- Why the change is needed +- Screenshots (if UI changes) +- Any relevant issue reference #### 📋 Pull Request Guidelines -Keep PRs small and focused. - -One feature or fix per PR. - -Avoid large unrelated changes. - -Ensure documentation is updated if needed. - -Be responsive to review feedback. +- Keep PRs small and focused +- One feature or fix per PR +- Avoid large unrelated changes +- Ensure documentation is updated if needed +- Be responsive to review feedback #### 🤝 Code of Conduct -#### Please be respectful and constructive in all communications. -#### We aim to maintain a welcoming and collaborative environment. +Please be respectful and constructive in all communications. We aim to maintain a welcoming and collaborative environment.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 84 - 117, The "Push and Open a Pull Request", "Pull Request Guidelines", and "Code of Conduct" sections need formatting fixes: change the git command under "Push and Open a Pull Request" from an h6 heading into a fenced code block (the line showing git push origin feature/your-feature-name), convert the PR contents paragraph ("Then open a Pull Request including: ...") into a proper bullet list with each item prefixed by a hyphen, convert the "Pull Request Guidelines" paragraph into a bullet list (Keep PRs small and focused; One feature or fix per PR; Avoid large unrelated changes; Ensure documentation is updated if needed; Be responsive to review feedback), and replace the emphasized h4-style lines under "Code of Conduct" with a single normal sentence (Please be respectful and constructive in all communications. We aim to maintain a welcoming and collaborative environment.) so headings and emphasis are used appropriately.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 45-56: Under the "3️⃣ Follow Project Standards" heading, replace
the six H6 pseudo-headings (lines starting with "######") with a proper Markdown
bullet list: convert each "###### Keep the project lightweight and
dependency-free.", "###### Follow the existing code style.", "###### Avoid
unnecessary libraries.", "###### Write clean, readable, and modular code.", and
"###### Do not break existing functionality." into list items (e.g. "- Keep the
project lightweight and dependency-free.") so the section uses a valid list
structure rather than heading-level jumps.
- Around line 57-68: The section starting with "### 4️⃣ Test Your Changes" uses
incorrect heading levels and treats each testing instruction as h5 headings;
change the subheading "##### Before submitting a Pull Request:" to a proper h4
(e.g., "#### Before submitting a Pull Request") and convert the subsequent h5
lines ("##### Open index.html in your browser.", "##### Test all social share
buttons.", "##### Ensure no console errors appear.", "##### Check responsiveness
on different screen sizes.") into a markdown checklist (e.g., "- [ ] Open
index.html in your browser", "- [ ] Test all social share buttons", "- [ ]
Ensure no console errors appear", "- [ ] Check responsiveness on different
screen sizes") so the hierarchy and format are correct and actionable for
contributors.
- Around line 34-44: The "Create a New Branch" section uses heading markup for
the git command and examples, breaking heading hierarchy; change the line
containing the git command (currently marked "#### git checkout -b
feature/your-feature-name") into a fenced code block (```bash ... ```), replace
the example lines currently using h5 headings (e.g., the lines with
"feature/add-linkedin-support", "fix/button-alignment-issue",
"docs/update-readme") with a bulleted list of inline code items (e.g., -
`feature/add-linkedin-support`), and ensure the main section heading "### 2️⃣
Create a New Branch" is followed by descriptive text or bullets (not additional
heading levels) to restore correct heading hierarchy and accessible Markdown
structure.
- Around line 69-83: The "Commit Your Changes" section uses inconsistent heading
levels and places the commit format and examples in headings instead of code
blocks; update the "### 5️⃣ Commit Your Changes" subsection so headings follow a
consistent hierarchy (keep the main title as "### 5️⃣ Commit Your Changes" and
"Use clear and meaningful commit messages." as plain text), replace the "######
type: short description" heading with an inline description and a fenced code
block showing the commit format (e.g., ```type: short description```), and
convert the examples under "Examples:" into a fenced code block containing the
three sample commits ("feat: add Twitter share support", "fix: resolve mobile
button spacing issue", "docs: improve README installation section"); ensure
"Examples:" is bold or plain text (not a heading) and remove mixed h4/h5/h6
usage so the section is semantically correct.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 84-117: The "Push and Open a Pull Request", "Pull Request
Guidelines", and "Code of Conduct" sections need formatting fixes: change the
git command under "Push and Open a Pull Request" from an h6 heading into a
fenced code block (the line showing git push origin feature/your-feature-name),
convert the PR contents paragraph ("Then open a Pull Request including: ...")
into a proper bullet list with each item prefixed by a hyphen, convert the "Pull
Request Guidelines" paragraph into a bullet list (Keep PRs small and focused;
One feature or fix per PR; Avoid large unrelated changes; Ensure documentation
is updated if needed; Be responsive to review feedback), and replace the
emphasized h4-style lines under "Code of Conduct" with a single normal sentence
(Please be respectful and constructive in all communications. We aim to maintain
a welcoming and collaborative environment.) so headings and emphasis are used
appropriately.
Removed duplicate lines and ensured clarity in the contributing guidelines.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
103-113: PR guidelines read as loose paragraphs — convert to a bullet list for consistency.The five guideline items under
#### 📋 Pull Request Guidelinesare formatted as separate plain paragraphs rather than a list, inconsistent with the rest of the document.♻️ Proposed refactor
-Keep PRs small and focused. - -One feature or fix per PR. - -Avoid large unrelated changes. - -Ensure documentation is updated if needed. - -Be responsive to review feedback. +- Keep PRs small and focused. +- One feature or fix per PR. +- Avoid large unrelated changes. +- Ensure documentation is updated if needed. +- Be responsive to review feedback.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 103 - 113, Under the "#### 📋 Pull Request Guidelines" section, replace the five separate paragraph lines ("Keep PRs small and focused.", "One feature or fix per PR.", "Avoid large unrelated changes.", "Ensure documentation is updated if needed.", "Be responsive to review feedback.") with a single bulleted list so formatting matches the rest of the document; locate the heading "#### 📋 Pull Request Guidelines" and convert those five individual paragraph entries into Markdown list items (e.g., "- Keep PRs small and focused.", "- One feature or fix per PR.", etc.) ensuring spacing and indentation match surrounding lists.
115-118: Code of Conduct is semantically misplaced as a subsection of "Push and Open a Pull Request".
#### 🤝 Code of Conductis nested under### 6️⃣ Push and Open a Pull Request, implying it's scoped to the PR workflow. A Code of Conduct applies to all project interactions and belongs at the top level (##).♻️ Proposed refactor
-#### 🤝 Code of Conduct +## 🤝 Code of Conduct🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 115 - 118, The "#### 🤝 Code of Conduct" heading is incorrectly nested under "### 6️⃣ Push and Open a Pull Request" so it reads as part of the PR workflow; move the Code of Conduct out of that subsection and make it a top-level section by changing the heading to "## 🤝 Code of Conduct" (or "## Code of Conduct") and relocating its content to the main sections area near other top-level docs, ensuring the original bulleted lines ("Please be respectful..." and "We aim to maintain...") remain unchanged under that new top-level heading.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 36-75: Remove the stray leading '+' characters across the
CONTRIBUTING.md sections (notably the "Create a New Branch", "3️⃣ Follow Project
Standards", "4️⃣ Test Your Changes", and "5️⃣ Commit Your Changes" headings) so
that markdown lists and fences render correctly; specifically, change the broken
code fence line to start with ```bash (no leading '+'), remove '+' prefixes from
list lines (convert instances of "+- " to "- " and fix the bullet typo "_
`feature/add-linkedin-support`" to "- `feature/add-linkedin-support`"), and
strip any lone '+' before bold or other text (e.g., "+**Format:**" ->
"**Format:**") so all bullets and fences follow standard GFM/CommonMark syntax.
- Around line 88-101: Replace the inline markdown heading used for the git push
command with a fenced code block containing the command (the line showing "git
push origin feature/your-feature-name"), and convert the freeform PR guidance
lines into a proper bulleted list with each item prefixed by a hyphen and a
space (items: "What changes were made", "Why the change is needed", "Screenshots
(if UI changes)", "Any relevant issue reference") so the section follows
markdown linting and renders as a list.
---
Duplicate comments:
In `@CONTRIBUTING.md`:
- Around line 77-84: Replace the incorrect headings and plain-text examples:
remove the h6 heading "###### type: short description" and render it as plain
text "type: short description"; change the h5 "##### Examples:" to plain bold
text "**Examples:**"; and wrap the example commit lines ("feat: add Twitter
share support", "fix: resolve mobile button spacing issue", "docs: improve
README installation section") inside a fenced code block so the commit examples
are formatted correctly.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 103-113: Under the "#### 📋 Pull Request Guidelines" section,
replace the five separate paragraph lines ("Keep PRs small and focused.", "One
feature or fix per PR.", "Avoid large unrelated changes.", "Ensure documentation
is updated if needed.", "Be responsive to review feedback.") with a single
bulleted list so formatting matches the rest of the document; locate the heading
"#### 📋 Pull Request Guidelines" and convert those five individual paragraph
entries into Markdown list items (e.g., "- Keep PRs small and focused.", "- One
feature or fix per PR.", etc.) ensuring spacing and indentation match
surrounding lists.
- Around line 115-118: The "#### 🤝 Code of Conduct" heading is incorrectly
nested under "### 6️⃣ Push and Open a Pull Request" so it reads as part of the
PR workflow; move the Code of Conduct out of that subsection and make it a
top-level section by changing the heading to "## 🤝 Code of Conduct" (or "##
Code of Conduct") and relocating its content to the main sections area near
other top-level docs, ensuring the original bulleted lines ("Please be
respectful..." and "We aim to maintain...") remain unchanged under that new
top-level heading.
Removed unnecessary hyphens and fixed formatting in the CONTRIBUTING.md file.
Contributor
There was a problem hiding this comment.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@CONTRIBUTING.md`:
- Around line 36-45: Remove the leftover literal '+' characters and fix the
malformed fenced code block in CONTRIBUTING.md: replace the lines that start
with "+Always..." and "+**Examples:**" to normal text (no leading '+'), change
the "+```bash" and closing "+```" to a proper triple-backtick fence enclosing
the git command "git checkout -b feature/your-feature-name", and convert the
list items that currently show "+_ `feature/add-linkedin-support`" / "+-
`fix/button-alignment-issue`" / "+- `docs/update-readme`" into a standard
markdown list using "-" (e.g., "- feature/add-linkedin-support", "-
fix/button-alignment-issue", "- docs/update-readme") so the Examples block and
code fence render correctly.
- Around line 88-101: Replace the erroneous h6 heading used for the push command
with a fenced bash code block containing the line "git push origin
feature/your-feature-name" and close the fence; then convert the flat sibling
list under "Then open a Pull Request including:" into a parent paragraph
followed by a properly nested bullet list (make the four PR items children of
that intro line) so the PR-contents appear as subitems rather than peers.
- Around line 77-84: Replace the incorrect h6 heading "###### type: short
description" with an h4 heading "#### type: short description" in the commit
format section and wrap the example commits under "Examples:" in a fenced code
block; specifically update the block that currently contains the literal lines
"###### type: short description" and the following "Examples:" plus the three
example lines ("feat: add Twitter share support", "fix: resolve mobile button
spacing issue", "docs: improve README installation section") so that the
examples are enclosed between triple backticks (``` ) with a matching closing
fence.
Contributor
|
@amankv1234 try to follow: https://github.com/AOSSIE-Org/Template-Repo/blob/main/CONTRIBUTING.md |
Contributor
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 38306
Critical Missing SectionsThe current PR is missing several important sections from the template: 🚨 1. Discord Communication Requirement (MANDATORY)The template emphasizes that all project communication MUST happen on Discord with a prominent warning section. This is completely missing from the current PR and appears to be a critical organizational requirement. 2. Table of ContentsThe template includes a navigation-friendly table of contents. 3. Issue-First WorkflowThe template clearly states under "Contributing Code":
4. Setup Instructions Missing
5. PR Description TemplateThe template provides a structured PR template with checkboxes for contributors to follow. 6. Community Guidelines SectionIncluding:
CodeRabbit's Review Comments to AddressCodeRabbit flagged several markdown formatting issues that need fixing:
Recommended Action
Would you like me to help you create a properly structured CONTRIBUTING.md that merges the template requirements with your project-specific details? |
kpj2006
reviewed
Feb 18, 2026
Added guidelines for Discord communication and issue assignment.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
149-152:Code of Conductis buried as an####subsection inside PR Guidelines.This is a foundational community policy and should be a top-level
##section — not nested under PR workflow — both for discoverability and to signal its importance. Its two bullet points also overlap with the## 🌟 Community Guidelinessection (lines 156–158); consider consolidating or cross-referencing.📝 Proposed fix (promote to top-level and remove duplication)
-#### 🤝 Code of Conduct - -- Please be respectful and constructive in all communications. -- We aim to maintain a welcoming and collaborative environment.Add as a top-level section (after Community Guidelines or before it):
## 🤝 Code of Conduct Please be respectful and constructive in all communications. We aim to maintain a welcoming and collaborative environment. See our full [Code of Conduct](CODE_OF_CONDUCT.md) for details.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 149 - 152, Promote the "#### 🤝 Code of Conduct" subsection to a top-level "## 🤝 Code of Conduct" section (place it before or after "## 🌟 Community Guidelines") and replace the nested bullets with a concise top-level paragraph plus a pointer to the standalone CODE_OF_CONDUCT.md file; also remove or consolidate the duplicate bullet lines from "## 🌟 Community Guidelines" to avoid redundancy and ensure the new "## 🤝 Code of Conduct" is the single authoritative reference.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 61-68: Remove the trailing space after the opening fenced code
block marker (the "```bash " fence) and replace the invalid underscore list
marker (`_ ` before `feature/add-linkedin-support`) with a normal hyphen or
backtick-marked list item; specifically update the fenced code block header from
"```bash " to "```bash" and change the offending line starting with "_
`feature/add-linkedin-support`" to "- `feature/add-linkedin-support`" so the
list renders as a proper unordered list in CONTRIBUTING.md.
- Around line 53-56: Insert a single blank line between the closing code fence
```bash``` (the git clone snippet) and the following bullet "- Add upstream
remote:" so the markdown has a blank line separating the fenced code block and
the subsequent list item; update the section in CONTRIBUTING.md where the
```bash``` fence precedes the "- Add upstream remote:" bullet to add that empty
line.
- Around line 15-22: Update the Table of Contents so entries exactly match the
actual second-level headings and become functional Markdown anchor links:
replace the plain list items with linked anchors that match the heading
text/slug (e.g., change "- Getting Started" to "- [Getting
Started](`#getting-started`)" and ensure entries like "Development Workflow" and
"Code Style" are renamed to the actual headings present in the document such as
"Community Guidelines" or add the missing "## Development Workflow" / "## Code
Style" headings if intended; ensure each list item uses the correct
bracket/parenthesis Markdown link format and slugified anchor that matches the
corresponding "##" heading.
---
Duplicate comments:
In `@CONTRIBUTING.md`:
- Around line 132-148: Change the heading hierarchy so "📋 Pull Request
Guidelines" is higher-level than "✅ Before Submitting" (e.g., make "📋 Pull
Request Guidelines" `##` or `###` instead of `####`) so "✅ Before Submitting"
nests correctly, and remove the stray empty checklist item "- [ ]" (the blank
checkbox) under the checklist; update the headings using the literal strings "📋
Pull Request Guidelines" and "✅ Before Submitting" and delete the orphan "- [ ]"
list entry.
- Around line 96-107: Replace the h6 heading "###### type: short description"
with a fenced code block containing the literal "type: short description" and
wrap the three commit examples ("feat: add Twitter share support", "fix: resolve
mobile button spacing issue", "docs: improve README installation section")
inside a fenced code block as well so the commit format and examples are treated
as code (locate the strings "###### type: short description" and the example
lines to update).
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 149-152: Promote the "#### 🤝 Code of Conduct" subsection to a
top-level "## 🤝 Code of Conduct" section (place it before or after "## 🌟
Community Guidelines") and replace the nested bullets with a concise top-level
paragraph plus a pointer to the standalone CODE_OF_CONDUCT.md file; also remove
or consolidate the duplicate bullet lines from "## 🌟 Community Guidelines" to
avoid redundancy and ensure the new "## 🤝 Code of Conduct" is the single
authoritative reference.
Updated the Table of Contents and added instructions for adding an upstream remote.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
151-154: Elevate "Code of Conduct" to a top-level section and consolidate with "Community Guidelines".
#### 🤝 Code of Conductis buried at h4 inside the PR Guidelines subsection and its content (respectful communication, welcoming environment) overlaps almost entirely with## 🌟 Community Guidelinesat Line 156. The template and previous review comments recommended making it a top-level (##) section.Consider merging both into a single
## 🤝 Code of Conductsection and removing the redundant## 🌟 Community Guidelines.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 151 - 154, Elevate the "#### 🤝 Code of Conduct" subsection to a top-level heading and merge its content with the existing "## 🌟 Community Guidelines": replace both sections with a single "## 🤝 Code of Conduct" that contains the consolidated points about respectful communication and a welcoming environment, and remove the redundant "## 🌟 Community Guidelines" heading; ensure any references/TOC entries that pointed to "Community Guidelines" are updated to the new "Code of Conduct" heading.
119-122: Remove leading space inside the git push code block.Line 121 has a stray leading space before
git push, which will be copied verbatim by contributors.📝 Proposed fix
```bash - git push origin feature/your-feature-name + git push origin feature/your-feature-name</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@CONTRIBUTING.mdaround lines 119 - 122, Remove the stray leading space
inside the git push code block so the command exactly readsgit push origin feature/your-feature-name; edit the code fence block in CONTRIBUTING.md to
remove the initial space character beforegit push origin feature/your-feature-nameso contributors copying the snippet get a correct
command.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@CONTRIBUTING.md:
- Around line 134-150: The Pull Request Guidelines section has inconsistent
heading levels, an empty checklist item, and mixed list formats; update the
heading "#### 📋 Pull Request Guidelines" to a top-level section heading "## 📋
Pull Request Guidelines" (or remove it from the TOC), change "### ✅ Before
Submitting" to a subordinate heading that fits the new hierarchy (e.g., "### ✅
Before Submitting" should become "### ✅ Before Submitting" only if promoted
appropriately—ensure headings follow logical nesting under "## 📋 Pull Request
Guidelines"), remove the stray empty checklist item "- [ ]" and convert the
loose bullets under the checklist ("- Keep PRs small and focused.", "One feature
or fix per PR.", etc.) into the same checkbox/list format as the preceding items
for consistency (or vice versa: make all checklist items plain bullets), keeping
the existing heading texts ("📋 Pull Request Guidelines" and "✅ Before
Submitting") to locate the changes.- Around line 100-109: The markdown still has an h6 heading marker "######"
under the "Format:" section and the commit examples are not wrapped in a fenced
code block; replace the h6 "###### type: short description" with the correct h4
(i.e., use four #) under the "Format:" heading and surround the example commits
(the lines beginning with "feat:", "fix:", "docs:") with a fenced
triple-backtick block so the examples render as code; adjust the surrounding
text so "Examples:" remains outside the code fence and the three example lines
are inside.
Duplicate comments:
In@CONTRIBUTING.md:
- Around line 17-22: Remove the erroneous backticks around the URL fragments in
the TOC links and fix the extra leading space on the first list item: replace
occurrences like "Ways to Contribute" (and the similar
lines for Getting Started, Pull Request Guidelines, Community Guidelines,
Getting Help, Issue Assignment) with the correct GFM anchor form
"(#-ways-to-contribute)" (no backticks), and trim the leading space before the
first list item so the markdown renders correctly.- Around line 124-132: Adjust the Markdown so the checklist items are nested
under the introductory line "Then open a Pull Request including:" by making that
line a top-level bullet and converting the subsequent lines ("What changes were
made", "Why the change is needed", "Screenshots (if UI changes)", "Any relevant
issue reference") into an indented sub-list (e.g., prefix each with two spaces
or a tab) beneath it; update the block containing "Then open a Pull Request
including:" and its following list entries to use proper Markdown nesting so the
items are children of the intro line.
Nitpick comments:
In@CONTRIBUTING.md:
- Around line 151-154: Elevate the "#### 🤝 Code of Conduct" subsection to a
top-level heading and merge its content with the existing "## 🌟 Community
Guidelines": replace both sections with a single "## 🤝 Code of Conduct" that
contains the consolidated points about respectful communication and a welcoming
environment, and remove the redundant "## 🌟 Community Guidelines" heading;
ensure any references/TOC entries that pointed to "Community Guidelines" are
updated to the new "Code of Conduct" heading.- Around line 119-122: Remove the stray leading space inside the git push code
block so the command exactly readsgit push origin feature/your-feature-name;
edit the code fence block in CONTRIBUTING.md to remove the initial space
character beforegit push origin feature/your-feature-nameso contributors
copying the snippet get a correct command.</details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Added a Code of Conduct document outlining community standards and expectations.
kpj2006
requested changes
Feb 19, 2026
Updated links in the Table of Contents and removed Code of Conduct section.
kpj2006
requested changes
Feb 20, 2026
Contributor
There was a problem hiding this comment.
@amankv1234 can you remove CODE_OF_CONDUCT.md
as we will follow CONDUCT from .github repo which is rolls out to whole org.
Contributor
Author
|
@kpj2006 Removed CODE_OF_CONDUCT.md as requested. Kindly review the PR. |
kpj2006
approved these changes
Feb 22, 2026
Contributor
|
thanks for contribution!! |
Contributor
Author
|
@kpj2006 Thank you for accepting and merging my contribution! 🙌 I really appreciate your guidance throughout the review process. |
Contributor
|
Join the discord where we will discuss further. I have shared link of discord in chats somewhere, let me know if you can't find it |
Contributor
|
@amankv1234 you can work on #19 |
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a CONTRIBUTING.md file to align the repository with open-source best practices.
The file includes:
No functional changes were introduced.
Closes #18
Summary by CodeRabbit