docs: update contributing-guidelines

[sheikhlimon]

Description

recording.mp4

Fixes #819

Type of Change

• New feature (e.g., new page, component, or functionality)
• Bug fix (non-breaking change that fixes an issue)
• UI/UX improvement (design, layout, or styling updates)
• Performance optimization (e.g., code splitting, caching)
• Documentation update (README, contribution guidelines, etc.)
• Other (please specify):

Changes Made

• README.md

• Project logo, name, tagline

• Badges (Stars, Forks, PRs, Issues, Contributors)

• Short project description

• Quick links: Contributing Guidelines, ESLint/TypeScript guide

• Quick start (clone, install, start dev server)

• Tech stack (frameworks, libraries, styling, UI components)

• Development: Docker dev instructions

• Footer: Community, newsletter, social media links

• community/contributing-guidelines.md

• Title and intro thanking contributors

• Getting Started: clone, install, start dev server

• Code Quality & Development Setup: ESLint, Prettier, TypeScript, Husky, npm scripts

• Branching & PR Workflow: branch naming, PR submission, flowchart

• Code Style Guidelines: TypeScript + React best practices, naming, branding, commit messages

• Troubleshooting / common errors

• Footer: links to Discord/community channels

• community/understand-eslint.md

• Detailed ESLint rules explanation

• Prettier formatting examples

• How to run lint, fix, typecheck, and format commands

• Example project directory structure

Dependencies

• n/a
• n/a

Checklist

• My code follows the style guidelines of this project.
• I have tested my changes across major browsers and devices
• My changes do not generate new console warnings or errors .
• I ran npm run build and attached screenshot(s) in this PR.
• This is already assigned Issue to me, not an unassigned issue.

[vercel]

@sheikhlimon is attempting to deploy a commit to the recode Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. The estimated time for response is 5–8 hrs.

In the meantime, please provide all necessary screenshots and make sure you run - npm build run , command and provide a screenshot, a video recording, or an image of the update you made below, which helps speed up the review and assignment. If you have questions, reach out to LinkedIn. Your contributions are highly appreciated!😊

Note: I maintain the repo issue every day twice at 8:00 AM IST and 9:00 PM IST. If your PR goes stale for more than one day, you can tag and comment on this same issue by tagging @sanjay-kv.

We are here to help you on this journey of open source. Consistent 20 contributions are eligible for sponsorship 💰

🎁 check our list of amazing people we sponsored so far: GitHub Sponsorship. ✨

📚Your perks for contribution to this community 👇🏻

1. Get free Consultation use code recode50 to get free: Mentorship for free.

2. Get the Ebook for free use code recode at checkout: Data Science cheatsheet for Beginners.

3. Check out this weekly Newsletter: Sanjay's Newsletter.

If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

[github-actions]

Synced data from Linked Issues

Labels:

• enhancement
• level 1
• recode
• hacktoberfest-accepted

Assignees:

• sheikhlimon

Milestones:

• recode:launch 3.0

[sheikhlimon]

@sanjay-kv done see if you like the new changes

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
recode-website	Ready	Preview	Comment	Oct 8, 2025 7:03am