Skip to content

docs: document all environment variables in README and env.example#1014

Open
tmdeveloper007 wants to merge 4 commits into
Priyanshu-byte-coder:mainfrom
tmdeveloper007:#968
Open

docs: document all environment variables in README and env.example#1014
tmdeveloper007 wants to merge 4 commits into
Priyanshu-byte-coder:mainfrom
tmdeveloper007:#968

Conversation

@tmdeveloper007
Copy link
Copy Markdown
Contributor

Closes #968.

Summary of What Has Been Done:
Thoroughly documented all supported environment variables for easier contributor onboarding.

Changes Made:

  • Added a detailed environment variables reference table to README.md complete with Required/Optional labels, descriptions, and recommendation values.
  • Updated .env.example to document GROQ_API_KEY for AI weekly insights module.
  • Appended warning about never committing sensitive .env files to Git.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 25, 2026

@TESTPERSONAL is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added gssoc26 GSSoC 2026 contribution type:accessibility GSSoC type bonus: accessibility (+15 pts) type:docs GSSoC type bonus: documentation (+5 pts) labels May 25, 2026
@github-actions
Copy link
Copy Markdown

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — 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

The DashboardHeader renders the h1 as 'DASHBOARD' (all-caps via
design), but the Playwright selectors used an exact-case match
{ name: "Dashboard" } which never matched.

Changed all three heading assertions to /dashboard/i regex so they
match the actual DOM output and unblock every failing E2E test.
@github-actions github-actions Bot added the type:testing GSSoC type bonus: tests (+10 pts) label May 25, 2026
landing.spec.js:
- Remove assertion for 'DevTrack' h1 (hero reads 'YOUR CODE HAS A PULSE')
- Add .first() to 'Sign in with GitHub' link selectors (2 links on page,
  strict mode violation)
- Replace 'View on GitHub' link with '★ Star on GitHub' (actual text)

auth-bypass.spec.js:
- Add .first() to 'Sign in with GitHub' link (strict mode violation)
- Change heading assertions from exact 'Dashboard' to /dashboard/i regex

dashboard-widgets.spec.js:
- Add mock for /api/goals/sync so GoalTracker doesn't hang waiting for
  a real Supabase call (Goals heading was never rendering in CI)
- Add mocks for additional API routes hit on dashboard load
@github-actions github-actions Bot added the type:security GSSoC type bonus: security (+20 pts) label May 25, 2026
@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

Hi! This PR now has a merge conflict with main, likely on the shared e2e test files (e2e/dashboard-widgets.spec.js, e2e/auth-bypass.spec.js, e2e/landing.spec.js). Multiple PRs were merged recently and the e2e files updated. Please rebase onto the latest main:

git fetch origin
git rebase origin/main
# resolve any conflicts
git push --force-with-lease

Your actual feature/fix changes are valuable — we'd love to get this merged once rebased!

# Conflicts:
#	e2e/landing.spec.js
@tmdeveloper007
Copy link
Copy Markdown
Contributor Author

tmdeveloper007 commented May 25, 2026

Hi @Priyanshu-byte-coder!

Just wanted to update you that this Pull Request has been fully rebased against the latest main branch, all conflicts have been resolved, and all CI checks (including TypeScript compilation, lint rules, and Playwright E2E smoke tests) are now 100% green and passing!

It is fully ready for your final review and merging. Thank you so much for your time and hard work in organizing GSSoC 2026!

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

Labels

gssoc26 GSSoC 2026 contribution type:accessibility GSSoC type bonus: accessibility (+15 pts) type:docs GSSoC type bonus: documentation (+5 pts) type:security GSSoC type bonus: security (+20 pts) type:testing GSSoC type bonus: tests (+10 pts)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Document all required and optional environment variables in README

2 participants