Skip to content

docs: enhance developer guide with linting rules and env setup (#379)#467

Open
MsParadox wants to merge 1 commit into
indresh404:mainfrom
MsParadox:docs/env-linting-guide
Open

docs: enhance developer guide with linting rules and env setup (#379)#467
MsParadox wants to merge 1 commit into
indresh404:mainfrom
MsParadox:docs/env-linting-guide

Conversation

@MsParadox

Copy link
Copy Markdown
Contributor

Pull Request 🚀

Description

This PR addresses the documentation gap highlighted in Issue #379.
To improve the onboarding experience for new open-source contributors, I have updated the documentation to explicitly cover the .env setup and the mandatory code quality checks.

Changes Made:

  • CONTRIBUTING.md: Added a new "Code Quality & Linting" section that instructs contributors to run node fix_lint.mjs before opening a PR.
  • DEVELOPER_GUIDE.md: Clarified the Environment Variables step to explicitly instruct users to copy from .env.example.
  • DEVELOPER_GUIDE.md: Added the linting script requirement to the "Contribution Workflow" checklist.

Related Issue

Closes #379

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Screenshots / Videos (if applicable)

N/A - Documentation only.

Testing Done

  • Verified that there are no markdown-linting errors in the new text.
  • Verified formatting previews correctly on GitHub.

Checklist

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings or console errors.
  • Any dependent changes have been merged and published in downstream modules.

Contributor Declaration

  • I confirm that this contribution is made under the rules of GSSoC 2026 and NSoC 2026.
  • I confirm that I have been assigned the related issue by a maintainer before opening this PR.
  • I have read the Contributing Guidelines and Code of Conduct.

@MsParadox MsParadox requested a review from indresh404 as a code owner June 11, 2026 20:25
@vercel

vercel Bot commented Jun 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ranker-hub Ready Ready Preview, Comment Jun 11, 2026 8:26pm

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request frontend Frontend related changes (HTML/CSS/JS/React) gssoc GirlScript Summer of Code gssoc26 GirlScript Summer of Code 2026 nsoc NSoC NSoC'26 NSoC 2026 pending-review PR is pending review labels Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request frontend Frontend related changes (HTML/CSS/JS/React) gssoc GirlScript Summer of Code gssoc26 GirlScript Summer of Code 2026 nsoc NSoC NSoC'26 NSoC 2026 pending-review PR is pending review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Enhance DEVELOPER_GUIDE.md with local environment setup and linting rules

1 participant