Skip to content

docs(contributing): add FAQ for new and GSSoC contributors#2513

Open
Honey-pg wants to merge 1 commit into
Umbrella-io:mainfrom
Honey-pg:docs/contributing-faq
Open

docs(contributing): add FAQ for new and GSSoC contributors#2513
Honey-pg wants to merge 1 commit into
Umbrella-io:mainfrom
Honey-pg:docs/contributing-faq

Conversation

@Honey-pg

Copy link
Copy Markdown
Contributor

Summary

Document common setup, assignment, PR, and scoring questions and align auto-unassign timing with the 7-day bot rule.

Adds a comprehensive FAQ section to CONTRIBUTING.md for new and GSSoC contributors, covering setup, issue assignment, pull requests, GSSoC scoring labels, and troubleshooting. Also updates Section 7 to reflect the correct 7-day auto-unassignment rule and maintainer scoring label requirements.

Closes #2476


Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that changes existing behavior)
  • 📝 Documentation update
  • ♻️ Refactor / code cleanup (no functional change)
  • ⚡ Performance improvement
  • 🔒 Security fix
  • 🧪 Tests only

What Changed

  • Added Section 10 — Frequently Asked Questions (FAQ) to CONTRIBUTING.md with 22 collapsible <details> entries
  • Getting Started — assignment requirements, npm vs pnpm, required env vars, setup guide links
  • Issues and PRs — claiming issues, 7-day PR deadline, branch naming, PR requirements, fork sync
  • GSSoC 2026 — points system, scoring labels (level:*, gssoc:approved), docs contributions, mentorship comments
  • Troubleshooting — Husky/pre-commit, CI failures, OAuth login, where to ask for help, merge conflicts
  • Updated Section 7 — corrected auto-unassignment from 3 days to 7 days without a PR; added note on maintainer-applied GSSoC scoring labels
  • Updated Table of Contents — added link to Section 10

How to Test

  1. Open CONTRIBUTING.md on GitHub and verify Section 10 renders with collapsible FAQ entries.
  2. Click through each <details> block — answers should expand/collapse correctly.
  3. Confirm internal links resolve: DEVELOPMENT.md, docs/architecture.md, docs/self-hosting.md, docs/HUSKY_TROUBLESHOOTING.md, and #3-environment-variables-guide.
  4. Verify Section 7 now states 7 days for auto-unassignment (not 3 days).
  5. Confirm Table of Contents item 10 links to #10-frequently-asked-questions-faq.

Expected result: FAQ is readable, links work, and assignment/scoring guidance matches the actual GitHub bot workflows.


Checklist

  • Linked the related issue above
  • Self-reviewed my own diff
  • No unnecessary console.log, debug code, or commented-out blocks
  • npm run lint passes locally (N/A — docs-only)
  • No TypeScript errors (npm run type-check) (N/A — docs-only)
  • Added or updated tests where applicable (N/A — docs-only)
  • Updated documentation / comments if behavior changed

Additional Context

  • FAQ clarifies npm vs pnpm discrepancy: CI uses npm ci + package-lock.json; contributors should use npm for CI parity.
  • GSSoC scoring labels on PRs (level:beginner, gssoc:approved, etc.) are applied by maintainers at merge time — documented in both Section 7 and the FAQ.
  • Optional follow-up: remove duplicate "GSSoC Git Commit & Branching Conventions" block at the bottom of CONTRIBUTING.md (lines 218–266) to reduce confusion with Sections 5–6.

Document common setup, assignment, PR, and scoring questions and align auto-unassign timing with the 7-day bot rule.
@github-actions github-actions Bot added type:docs GSSoC type bonus: documentation (+5 pts) gssoc26 GSSoC 2026 contribution type:feature GSSoC type bonus: new feature labels Jun 17, 2026
@github-actions

Copy link
Copy Markdown

GSSoC Label Checklist 🏷️

@Umbrella-io — please apply the appropriate labels before merging:

Difficulty (pick one):

  • level:beginner — 20 pts
  • level:intermediate — 35 pts
  • level:advanced — 55 pts
  • level:critical — 80 pts

Quality (optional):

  • quality:clean — ×1.2 multiplier
  • quality:exceptional — ×1.5 multiplier

Validation (required to score):

  • gssoc:approved — counts for points
  • gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

@Priyanshu-byte-coder

Copy link
Copy Markdown
Member

CI is failing on the type check. Please fix the TypeScript errors and push again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc26 GSSoC 2026 contribution type:docs GSSoC type bonus: documentation (+5 pts) type:feature GSSoC type bonus: new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add FAQ section to contributing.md

2 participants