feat: Add contributing.md file #302
feat: Add contributing.md file #302intojhanurag wants to merge 4 commits intocontainer-registry:mainfrom
Conversation
📝 WalkthroughWalkthroughAdds a new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 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 |
Codacy's Analysis Summary2 new issues (≤ 0 issue) Review Pull Request in Codacy →
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 5-35: The CONTRIBUTING.md change must include and reference the
interim DEVELOPMENT.md required by Issue `#261`: create a new DEVELOPMENT.md (or
clearly labeled interim dev guide) containing the requested development setup
details and add a link from the "Set Up Development Environment" / "Getting
Started" section in CONTRIBUTING.md (where QUICKSTART.md is referenced) to point
to DEVELOPMENT.md as the interim resource; ensure the new doc name and the link
text clearly mention Issue `#261` so reviewers can verify the requirement is
satisfied.
- Around line 7-9: The issue is the issues link in CONTRIBUTING.md currently
points to the goharbor repo; update the markdown bullet that links to
https://github.com/goharbor/harbor-satellite so it points to the correct
repository (e.g. https://github.com/container-registry/harbor-satellite) or the
actual upstream org used by this project; modify the list item text/URL
accordingly to ensure contributors file issues in the right repo.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
82-95: Add blank lines around list blocks for Markdown linting.Codacy flags the lists under Bug Reports and Feature Requests for missing blank lines.
Proposed fix
Include: + - Expected behavior - Actual behavior - Steps to reproduce - Environment details (OS, Go version, etc.) - Relevant logs or error messages + ### Feature Requests Include: + - Use case description - Proposed solution - Alternatives considered - Any additional context
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 82-96: Add surrounding blank lines before and after the Markdown
list blocks to satisfy linting: insert a blank line before the "Include:" lists
under the first section and under "### Feature Requests", and ensure a blank
line before the opening <details> block and after its closing tag so the lists
are separated from surrounding paragraphs/headings.
|
Hey @bupd , Is this good to go ? PTAL :) |
Signed-off-by: intojhanurag <aojharaj2004@gmail.com>
Signed-off-by: intojhanurag <aojharaj2004@gmail.com>
Signed-off-by: intojhanurag <aojharaj2004@gmail.com>
Signed-off-by: intojhanurag <aojharaj2004@gmail.com>
1eadfd5 to
f9ea187
Compare
Description
Added contributing.md file
Summary by cubic
Adds a CONTRIBUTING.md with clear guidelines for reporting issues, submitting PRs, and collaborating, making it easier for new contributors. Addresses #261.
Written for commit f9ea187. Summary will update on new commits.
Summary by CodeRabbit