eraser_clone icon indicating copy to clipboard operation
eraser_clone copied to clipboard
verified publisher icon kaifcoder

Add comprehensive CONTRIBUTING.md file for contributors

Open Copilot opened this issue 4 months ago • 1 comments

This PR adds a comprehensive CONTRIBUTING.md file to help new and existing contributors understand how to effectively contribute to the Eraser.io Clone project.

What's Added

The new CONTRIBUTING.md file includes:

  • Project Overview: Clear introduction to the tech stack (Next.js 14, TypeScript, Tailwind CSS, Shadcn/UI, Convex, Kinde Auth, EditorJS, Excalidraw)
  • Development Setup: Step-by-step installation and setup instructions with prerequisites
  • Project Structure: Visual representation of the codebase organization
  • Contributing Workflow: Complete process from issue creation to PR submission
  • Code Guidelines: TypeScript best practices, component structure examples, and styling standards
  • Git Standards: Branch naming conventions and commit message formats
  • Issue & PR Guidelines: Templates and expectations for bug reports, feature requests, and pull requests
  • Testing Information: Current testing approach and expectations
  • Code of Conduct: Guidelines for maintaining a welcoming community environment

Why This Matters

Previously, the repository lacked formal contributing guidelines, which could make it challenging for new contributors to:

  • Set up their development environment correctly
  • Understand the project's coding standards
  • Follow the proper workflow for contributions
  • Know what information to include in issues and PRs

Features

  • Table of Contents for easy navigation
  • Code examples showing proper component structure
  • Multiple package manager support (npm, yarn, pnpm, bun)
  • Accessibility considerations in styling guidelines
  • Recognition section to acknowledge contributors
  • Clear communication channels for getting help

This contributing guide aligns with modern open-source best practices while being specifically tailored to this project's Next.js architecture and collaborative tools.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot avatar Sep 20 '25 11:09 Copilot

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

Project Deployment Preview Comments Updated (UTC)
eraser-clone-qeci Error Error Sep 20, 2025 11:33am

vercel[bot] avatar Sep 20 '25 11:09 vercel[bot]