Skip to content

feat: Add contributing.md file #302

Open
intojhanurag wants to merge 4 commits intocontainer-registry:mainfrom
intojhanurag:feat/add-contributing-md-file
Open

feat: Add contributing.md file #302
intojhanurag wants to merge 4 commits intocontainer-registry:mainfrom
intojhanurag:feat/add-contributing-md-file

Conversation

@intojhanurag
Copy link
Contributor

@intojhanurag intojhanurag commented Feb 5, 2026

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.

  • Bug Fixes
    • Corrected Harbor Satellite links in the guide.
    • Removed the "issues" item from the Communication section; now points to Slack and email only.

Written for commit f9ea187. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contribution guidelines covering prerequisites and setup, ways to contribute, branching and workflow for small and large changes, testing requirements, pull-request and review guidance, issue-reporting templates, Developer Certificate of Origin (DCO) steps, communication channels, code of conduct, and where to get help.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 5, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

Adds a new CONTRIBUTING.md file with comprehensive contribution guidelines, including setup/prerequisites, branching and contribution workflows, testing and PR requirements, DCO instructions, review process, communication channels, and Code of Conduct.

Changes

Cohort / File(s) Summary
Contribution Guidelines
CONTRIBUTING.md
New file: comprehensive contribution guide covering project setup, branching workflow, contribution workflows for small/large changes, testing expectations, PR guidelines, issue reporting templates, DCO requirements, review process, communication channels, and Code of Conduct.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • bupd
  • Vad1mo
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding a CONTRIBUTING.md file, which aligns with the primary objective of the pull request.
Description check ✅ Passed The description follows the required template structure with 'Fixes' and 'Description' sections, though the description content is minimal and relies on auto-generated summary.
Linked Issues check ✅ Passed The PR successfully addresses issue #261 by adding CONTRIBUTING.md with contribution workflow, testing guidance, and development expectations to help new contributors.
Out of Scope Changes check ✅ Passed All changes are scoped to the CONTRIBUTING.md file addition, directly addressing the requirements in issue #261 with no extraneous modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codacy-production
Copy link

codacy-production bot commented Feb 5, 2026

Codacy's Analysis Summary

2 new issues (≤ 0 issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@intojhanurag
Copy link
Contributor Author

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>
@intojhanurag intojhanurag force-pushed the feat/add-contributing-md-file branch from 1eadfd5 to f9ea187 Compare February 8, 2026 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add contribution.md and development.md file

1 participant