Skip to content

feat: Enhance contributor guidelines with improved templates, linting, and code of conduct#241

Open
sathwik-ace-69 wants to merge 6 commits intoJollyJolli:mainfrom
sathwik-ace-69:fix/contributor-guidelines-improvements
Open

feat: Enhance contributor guidelines with improved templates, linting, and code of conduct#241
sathwik-ace-69 wants to merge 6 commits intoJollyJolli:mainfrom
sathwik-ace-69:fix/contributor-guidelines-improvements

Conversation

@sathwik-ace-69
Copy link

Summary

This pull request enhances the contributor guidelines and project infrastructure by implementing comprehensive improvements to issue templates, adding automated code quality checks, and establishing community standards.

Changes Made

1. Enhanced Issue Templates

  • bug_report.md: Added more detailed sections including Actual Behavior, Environment details, Additional Context, and Possible Solution
  • feature_request.md: Enhanced with Benefits, Possible Implementation, and willingness-to-work sections
  • custom-issue.md: Renamed to General Issue with structured sections for different types of inquiries

2. Code of Conduct

  • Added CODE_OF_CONDUCT.md using GitHub's Contributor Covenant v2.0
  • Establishes clear community standards and expectations
  • Provides enforcement guidelines and reporting mechanisms

3. Automated Linting Workflow

  • Created .github/workflows/lint.yml for automated code quality checks
  • Implements ESLint for JavaScript validation
  • Implements Stylelint for CSS validation
  • Configured to run on all pull requests to main branch

4. Updated CONTRIBUTING.md

  • Added new "Code of Conduct" section linking to CODE_OF_CONDUCT.md
  • Added new "Automated Linting" section explaining the linting process
  • Provided instructions for running linters locally
  • Improved documentation flow and structure

Benefits

  • ✅ Better quality issue reports with more detailed templates
  • ✅ Clearer community standards and behavior expectations
  • ✅ Automated code quality checks for all contributions
  • ✅ Consistent coding style enforcement
  • ✅ Improved contributor experience with better documentation

Testing

All changes have been tested:

  • Issue templates follow GitHub markdown format
  • CODE_OF_CONDUCT.md follows Contributor Covenant standard
  • Lint workflow YAML is valid and properly configured
  • CONTRIBUTING.md renders correctly with all links functional

Files Changed

  • .github/ISSUE_TEMPLATE/bug_report.md (enhanced)
  • .github/ISSUE_TEMPLATE/feature_request.md (enhanced)
  • .github/ISSUE_TEMPLATE/custom-issue.md (enhanced)
  • .github/workflows/lint.yml (new)
  • CODE_OF_CONDUCT.md (new)
  • CONTRIBUTING.md (updated)

@vercel
Copy link

vercel bot commented Oct 15, 2025

@sathwik-ace-69 is attempting to deploy a commit to the jollyjolli's projects Team on Vercel.

A member of the Team first needs to authorize it.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant