Add contributing guidelines including the current contributor list #57
Conversation
WalkthroughA new CONTRIBUTING.md file was added to provide detailed contribution guidelines for the project. The README.md was updated to include sections on contributing and star history, featuring links and badges to encourage community involvement and display repository popularity trends. No code or exported entities were modified. Changes
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 (
|
mertssmnoglu
force-pushed
the
contributing
branch
from
cd73346 to
a1e953b
Compare
Signed-off-by: Mert Şişmanoğlu <[email protected]>
mertssmnoglu
force-pushed
the
contributing
branch
from
6682f1a to
9af38be
Compare
… guidelines Signed-off-by: Mert Şişmanoğlu <[email protected]>
Signed-off-by: Mert Şişmanoğlu <[email protected]>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (8)
CONTRIBUTING.md (8)
5-9: “Getting Started” section is actionable.
The steps to star the repo, join Discord, and exploregood first issuetickets guide users effectively. Consider adding a direct link to thegood first issuefilter (e.g.https://github.com/bluewave-labs/capture/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to streamline discovery.
11-19: Comprehensive bug reporting guidelines.
You’ve covered title, reproduction steps, and expected vs. actual behavior well. Optionally, link “Search Existing Issues” to the issues page (https://github.com/bluewave-labs/capture/issues) to encourage contributors to check before filing.
20-27: Feature request instructions are clear.
The two-step checklist helps avoid duplicates and clarify proposals. Similar to bugs, you could add a “Create a Feature Request” link that points directly to an issue template if one exists.
37-43: Standardize repository clone instructions.
The SSH clone URL omits the.gitextension while the HTTPS URL includes it. For consistency, consider:-```bash - git clone [email protected]:bluewave-labs/capture +```bash +git clone [email protected]:bluewave-labs/capture.git
44-53: Align code block indentation.
Leading spaces before the backticks and commands may render inconsistently. To improve readability, de-indent fences and commands:- ```bash - go mod tidy - ``` +```bash +go mod tidy +```
55-61: Specify linting commands.
You mention running linters but don’t name one. Consider adding an example (e.g.,golangci-lint run) so contributors know exactly how to invoke the linter.
63-69: Branch and commit workflow is clear.
The steps are succinct. For consistency and conventional history, you might reference a commit message style (e.g., Conventional Commits) or link any existing guidelines if available.
70-70: Grammar nitpick: add missing article.
Change:-2. **Make Your Changes**: Ensure code is clean and well-documented. +2. **Make Your Changes**: Ensure the code is clean and well-documented.🧰 Tools
🪛 LanguageTool
[uncategorized] ~70-~70: You might be missing the article “the” here.
Context: ... ``` 2. Make Your Changes: Ensure code is clean and well-documented. 3. **Test...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~161-~161: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3466 characters long)
Context: ...# Contributing We welcome contributions! If you would like to contribute, please...
(EN_EXCESSIVE_EXCLAMATION)
CONTRIBUTING.md
[uncategorized] ~70-~70: You might be missing the article “the” here.
Context: ... ``` 2. Make Your Changes: Ensure code is clean and well-documented. 3. **Test...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🔇 Additional comments (5)
CONTRIBUTING.md (3)
1-4: Clear introduction and title.
The title and opening paragraph set a welcoming tone and clearly state the purpose of the document. Nice concise framing for new contributors.
28-34: Architecture overview links are useful.
Linking to both in-repo docs and an external DeepWiki page is helpful. Please verify that thedocs/README.md#high-level-overviewanchor exists and points to the intended section.
82-82: Welcoming closing message.
The final sentence reinforces appreciation and leaves a positive impression. Well done!README.md (2)
159-162: Verify CONTRIBUTING.md link resolution.
The relative path./CONTRIBUTING.mdshould work on GitHub, but double-check that it correctly navigates users to the new guidelines. If there’s an issue, consider using/CONTRIBUTING.md.🧰 Tools
🪛 LanguageTool
[style] ~161-~161: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3466 characters long)
Context: ...# Contributing We welcome contributions! If you would like to contribute, please...(EN_EXCESSIVE_EXCLAMATION)
167-170: Star History badge looks good.
The Star History section properly adds a badge and link to visualize the repo’s star count over time, enhancing community engagement.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
159-161: Suggest linking to a Code of Conduct
Consider adding a reference to aCODE_OF_CONDUCT.md(if you have one or plan to include it) to set clear expectations for community behavior.🧰 Tools
🪛 LanguageTool
[style] ~161-~161: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3453 characters long)
Context: ...# Contributing We welcome contributions! If you would like to contribute, please...(EN_EXCESSIVE_EXCLAMATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~161-~161: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3453 characters long)
Context: ...# Contributing We welcome contributions! If you would like to contribute, please...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (2)
README.md (2)
159-165: Well-structured Contributing section and accessible contributors badge
The new “Contributing” section clearly directs users toCONTRIBUTING.md, and the contributors badge now has a meaningfulaltattribute and proper spacing—great accessibility improvement!🧰 Tools
🪛 LanguageTool
[style] ~161-~161: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3453 characters long)
Context: ...# Contributing We welcome contributions! If you would like to contribute, please...(EN_EXCESSIVE_EXCLAMATION)
166-168: Star History badge integration looks good
The “Star History” chart badge is a valuable addition for showcasing project popularity trends.
CONTRIBUTING.mdSummary by CodeRabbit