Skip to content

docs: add .env.example for contributor onboarding#1492

Open
kumarishreya-ai-ds wants to merge 4 commits into
magic-peach:mainfrom
kumarishreya-ai-ds:issue-1332-add-env-example
Open

docs: add .env.example for contributor onboarding#1492
kumarishreya-ai-ds wants to merge 4 commits into
magic-peach:mainfrom
kumarishreya-ai-ds:issue-1332-add-env-example

Conversation

@kumarishreya-ai-ds

Copy link
Copy Markdown

Description

Adds a root .env.example file and improves contributor onboarding documentation.

The repository currently does not require any runtime environment variables. This PR documents that clearly and provides guidance for contributors who may need local overrides in the future.

Related Issue

Closes #1332

Type of Contribution

  • Bug fix
  • New feature
  • Documentation update
  • Refactor
  • GSSoC contribution

Participant Info

  • GitHub username: kumarishreya-ai-ds
  • Contribution level (Beginner/Intermediate/Advanced): Beginner

Screen Recording

Recording / Loom link: N/A (Documentation-only change, no UI or feature modifications)

Checklist

  • I have read the contribution guidelines
  • My changes follow the project structure
  • I have tested my changes in Chrome, Firefox, and Safari
  • bun run lint passes (documentation-only change)
  • bunx tsc --noEmit passes (documentation-only change)
  • New interactive elements have aria-label / accessible names
  • No console.log statements left in
  • This PR is related to a valid issue
  • Screen recording attached above (not applicable for documentation-only changes)

Changes Made

  • Added .env.example at the repository root
  • Documented that the project currently does not require runtime environment variables
  • Updated README with environment setup guidance
  • Updated CONTRIBUTING.md with onboarding instructions for .env.local

Investigation

Searched the repository for:

  • process.env
  • import.meta.env
  • NEXT_PUBLIC_*
  • VERCEL_*

No runtime environment variables are currently used by the project. The new .env.example acts as onboarding documentation and provides a clear starting point for future contributors.

@vercel

vercel Bot commented Jun 2, 2026

Copy link
Copy Markdown

@kumarishreya-ai-ds is attempting to deploy a commit to the magic-peach1's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

✅ PR Format Check Passed — @kumarishreya-ai-ds

Basic format checks passed. A maintainer will review your code changes.

This does not mean the PR is approved — it just means the format is correct.

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

👋 Thanks for your PR, @kumarishreya-ai-ds!

Welcome to Reframe — a browser-based video editor built for everyone 🎬

🟠 GSSoC'26 PR detected — thanks for contributing under GirlScript Summer of Code 2026!

What happens next

  1. 🤖 Automated checks — build & TypeScript typecheck will run automatically
  2. Vercel preview — a preview deployment will be created (requires maintainer authorization for fork PRs)
  3. 👀 Code review — a maintainer will review your changes
  4. 🚀 Merge — once approved, your PR will be merged!

Quick checklist

  • PR title follows Conventional Commits (e.g. feat: add dark mode)
  • Linked the issue this PR closes (e.g. Closes #123)
  • Tested the changes locally (bun run dev)
  • Build passes (bun run build)

Useful links

Happy coding! 🎉

@github-actions github-actions Bot added gssoc'26 GirlScript Summer of Code 2026 level:advanced Advanced level - 55 pts type:bug Bug fix type:design UI/UX design type:docs Documentation type:feature New feature type:refactor Code refactor labels Jun 2, 2026
@magic-peach

Copy link
Copy Markdown
Owner

@kumarishreya-ai-ds please resolve conflicts

@kumarishreya-ai-ds

Copy link
Copy Markdown
Author

@magic-peach can you review now , i have cleared the conflicts?

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

Labels

gssoc'26 GirlScript Summer of Code 2026 level:advanced Advanced level - 55 pts type:bug Bug fix type:design UI/UX design type:docs Documentation type:feature New feature type:refactor Code refactor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add .env.example for contributor onboarding

3 participants