Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add comprehensive CONTRIBUTING.md file for contributors #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into master
base: master
Choose a base branch
Loading
from copilot/fix-7a3b3097-7f63-491d-ae31-9ebf72f6df5c

Conversation

Copy link
Contributor

Copilot AI commented Sep 20, 2025
edited
Loading

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.

Copy link

vercel bot commented Sep 20, 2025
edited
Loading

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

Co-authored-by: kaifcoder <57701861+kaifcoder@users.noreply.github.com>
Copilot AI changed the title (削除) [WIP] Add contributing md file for contributors (削除ここまで) (追記) Add comprehensive CONTRIBUTING.md file for contributors (追記ここまで) Sep 20, 2025
Copilot AI requested a review from kaifcoder September 20, 2025 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@kaifcoder kaifcoder kaifcoder approved these changes

Reviewers whose approvals may not affect merge requirements

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

AltStyle によって変換されたページ (->オリジナル) /