docs: add CONTRIBUTING.md and GSSoC 2026 contributor guide (#342) - #497
Open
saurabhhhcodes wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md and GSSoC 2026 contributor guide (#342)#497saurabhhhcodes wants to merge 1 commit into
saurabhhhcodes wants to merge 1 commit into
Conversation
…#342) Adds a comprehensive CONTRIBUTING.md with: - Setup instructions for Go development - Fork and clone workflow - Coding standards and Go formatting - Test running instructions - PR submission guidelines - GSSoC 2026 contributor section Fixes agnivo988#342
Contributor
📝 WalkthroughWalkthroughA new CONTRIBUTING.md file is added to the repository root, providing contribution guidance including prerequisites, setup instructions, development workflow, PR submission steps, issue reporting, and a GSSoC 2026 contributors section. ChangesContributing Guide Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 22-49: The setup flow in CONTRIBUTING.md skips the dependency
download step, so update the “Fork and Clone” / “Building from Source”
instructions to include a `go mod download` step before running the build. Keep
the fix near the existing clone/build guidance and ensure the documented
workflow for the repository setup is complete from clone to build.
- Around line 113-118: The GSSoC 2026 contributor section in the CONTRIBUTING
guide is too minimal and the table of contents does not include it. Expand the
existing GSSoC 2026 section to cover how to claim an issue, the required PR
title format, point levels, and the meaning/use of the level1, level2, level3,
and gssoc-ext labels, and add a corresponding TOC entry so contributors can find
it easily. Refer to the existing “GSSoC 2026 Contributors” section and the
document’s TOC list when updating the content.
- Around line 53-91: Update the contributor guide section that currently covers
Branching, Coding Standards, Running Tests, and the Pre-commit Checklist to also
include guidance for commit message prefixes and running go vet. Add a short
commit convention entry near the existing branch-name examples, and add go vet
to the validation steps alongside go build and go test; keep the wording
consistent with the rest of CONTRIBUTING.md and use the existing section
structure so the new guidance is easy to find.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+22
to
+49
| - **Go 1.24+** — install via [gvm](https://github.com/moovweb/gvm) or [official installer](https://go.dev/dl/) | ||
| - **Git** — version 2.30 or later | ||
| - A **GitHub Personal Access Token** (classic) with `repo` and `read:org` scopes | ||
|
|
||
| ### Fork and Clone | ||
|
|
||
| 1. Fork the repository on GitHub. | ||
| 2. Clone your fork locally: | ||
| ```bash | ||
| git clone https://github.com/YOUR_USERNAME/Repo-lyzer.git | ||
| cd Repo-lyzer | ||
| ``` | ||
| 3. Add the upstream remote: | ||
| ```bash | ||
| git remote add upstream https://github.com/agnivo988/Repo-lyzer.git | ||
| ``` | ||
|
|
||
| ### Building from Source | ||
|
|
||
| ```bash | ||
| go build -o repo-lyzer ./cmd | ||
| ``` | ||
|
|
||
| The binary will be placed at `./repo-lyzer` in the project root. Run it with: | ||
|
|
||
| ```bash | ||
| ./repo-lyzer analyze --token YOUR_GITHUB_TOKEN --owner agnivo988 --repo Repo-lyzer | ||
| ``` |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Add the missing go mod download step.
Fresh-clone setup jumps straight from cloning to building; the documented workflow still omits the dependency download step required by the PR objective.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 22 - 49, The setup flow in CONTRIBUTING.md
skips the dependency download step, so update the “Fork and Clone” / “Building
from Source” instructions to include a `go mod download` step before running the
build. Keep the fix near the existing clone/build guidance and ensure the
documented workflow for the repository setup is complete from clone to build.
Comment on lines
+53
to
+91
| ### Branching | ||
|
|
||
| - Create a feature branch off `main`: `git checkout -b feat/my-feature` | ||
| - Use a descriptive branch name: `fix/login-error`, `feat/dashboard-widget`, `docs/contributing-guide` | ||
|
|
||
| ### Coding Standards | ||
|
|
||
| - Format all Go code with `gofmt` before committing: | ||
| ```bash | ||
| gofmt -s -w . | ||
| ``` | ||
| - Follow idiomatic Go conventions as described in [Effective Go](https://go.dev/doc/effective_go). | ||
| - Use meaningful variable names and avoid abbreviations where clarity matters. | ||
| - Keep functions focused and under 50 lines where practical. | ||
| - Add comments for exported functions, types, and package-level declarations. | ||
|
|
||
| ### Running Tests | ||
|
|
||
| Run the full test suite: | ||
|
|
||
| ```bash | ||
| go test ./... | ||
| ``` | ||
|
|
||
| Run tests for a specific package: | ||
|
|
||
| ```bash | ||
| go test ./cmd/... | ||
| ``` | ||
|
|
||
| ### Pre-commit Checklist | ||
|
|
||
| Before committing, ensure: | ||
|
|
||
| - [ ] `go build ./...` passes with no errors | ||
| - [ ] `go test ./...` passes with no failures | ||
| - [ ] `gofmt -s -w .` has been run | ||
| - [ ] New functionality includes tests | ||
| - [ ] Changes are accompanied by updated documentation |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Add go vet and commit-prefix guidance.
This section covers branch names, gofmt, and tests, but it never documents commit prefixes or go vet, both of which are required by the contributor guide objectives.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 53 - 91, Update the contributor guide section
that currently covers Branching, Coding Standards, Running Tests, and the
Pre-commit Checklist to also include guidance for commit message prefixes and
running go vet. Add a short commit convention entry near the existing
branch-name examples, and add go vet to the validation steps alongside go build
and go test; keep the wording consistent with the rest of CONTRIBUTING.md and
use the existing section structure so the new guidance is easy to find.
Comment on lines
+113
to
+118
| ### GSSoC 2026 Contributors | ||
|
|
||
| If you are contributing as part of **GSSoC 2026**: | ||
| - Comment on the issue you want to work on to get it assigned. | ||
| - Tag your PR with the relevant GSSoC labels. | ||
| - Reach out on the project's communication channel if you need guidance. |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Expand the GSSoC 2026 section.
The current text is too thin: it doesn't explain how to claim issues, the PR title format, point levels, or the level1/level2/level3/gssoc-ext labels, so contributors still need external guidance. Also add this section to the TOC.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 113 - 118, The GSSoC 2026 contributor section
in the CONTRIBUTING guide is too minimal and the table of contents does not
include it. Expand the existing GSSoC 2026 section to cover how to claim an
issue, the required PR title format, point levels, and the meaning/use of the
level1, level2, level3, and gssoc-ext labels, and add a corresponding TOC entry
so contributors can find it easily. Refer to the existing “GSSoC 2026
Contributors” section and the document’s TOC list when updating the content.
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
1 participant
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.
Adds a comprehensive CONTRIBUTING.md with setup instructions, development workflow, coding standards, test running, and GSSoC 2026 contributor guidance.
Fixes #342
Summary by CodeRabbit