docs: add CONTRIBUTING.md to align with open-source best practices#21
docs: add CONTRIBUTING.md to align with open-source best practices#21Vaishnavi10706 wants to merge 3 commits intoAOSSIE-Org:mainfrom
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 19-28: Wrap all inline shell commands in fenced code blocks using
the bash language (e.g., replace the inline "git clone
https://github.com/your-username/SocialShareButton.git", "cd SocialShareButton",
"npm install", "git checkout -b feature/your-feature-name", and "git push origin
feature/your-feature-name" with fenced blocks like ```bash\ngit clone ...\n```)
so each numbered step shows its command in a clear, copyable code block; apply
the same fenced-block formatting to the instances referenced at lines 57-58 as
well.
- Around line 67-69: Update the "## 🧑💻 Code of Conduct" section to reference
the actual file by name and provide a link to it (e.g., point to
CODE_OF_CONDUCT.md) so contributors can locate the document; edit the line that
currently reads "Please follow the project's Code of Conduct and maintain
respectful and inclusive communication." to include a direct reference such as
"Please read our Code of Conduct (CODE_OF_CONDUCT.md) for details on respectful
and inclusive communication." to make the location explicit.
| ## 🧑💻 Code of Conduct | ||
|
|
||
| Please follow the project's Code of Conduct and maintain respectful and inclusive communication. |
There was a problem hiding this comment.
Link to the Code of Conduct file.
Please reference the actual file (e.g., CODE_OF_CONDUCT.md) so contributors know exactly where to read it.
💡 Suggested wording
-Please follow the project's Code of Conduct and maintain respectful and inclusive communication.
+Please follow the project's Code of Conduct (see `CODE_OF_CONDUCT.md`) and maintain respectful and inclusive communication.📝 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.
| ## 🧑💻 Code of Conduct | |
| Please follow the project's Code of Conduct and maintain respectful and inclusive communication. | |
| ## 🧑💻 Code of Conduct | |
| Please follow the project's Code of Conduct (see `CODE_OF_CONDUCT.md`) and maintain respectful and inclusive communication. |
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 67 - 69, Update the "## 🧑💻 Code of Conduct"
section to reference the actual file by name and provide a link to it (e.g.,
point to CODE_OF_CONDUCT.md) so contributors can locate the document; edit the
line that currently reads "Please follow the project's Code of Conduct and
maintain respectful and inclusive communication." to include a direct reference
such as "Please read our Code of Conduct (CODE_OF_CONDUCT.md) for details on
respectful and inclusive communication." to make the location explicit.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 89-97: Remove the accidental triple-backtick fenced block around
the Code of Conduct section in CONTRIBUTING.md so the heading "## 🧑💻 Code of
Conduct" and its paragraph render as normal Markdown; simply delete the opening
and closing ```markdown``` fences and ensure the heading, paragraph, horizontal
rule (---) and closing thank-you line remain as plain Markdown.
|
mention issue in pr: #18 @amankv1234 already pick this up, you should move on to another file adding since there are multiple file to be added in this issue. |
@kpj2006 |
2 participants
Summary
This PR adds a CONTRIBUTING.md file to the SocialShareButton repository to align it with open-source best practices followed across the organization.
What’s Included
Why This Change
The repository currently lacks a standardized contribution guide. Adding this file improves contributor onboarding, ensures consistency, and enhances maintainability.
This PR implements only one best practice as per the issue instructions.
Summary by CodeRabbit