Skip to content

docs: add comprehensive contributing guide#13

Closed
vargas-jr[bot] wants to merge 1 commit into
mainfrom
add-contributing-guide
Closed

docs: add comprehensive contributing guide#13
vargas-jr[bot] wants to merge 1 commit into
mainfrom
add-contributing-guide

Conversation

@vargas-jr
Copy link
Copy Markdown

@vargas-jr vargas-jr Bot commented Feb 8, 2026

Adds a comprehensive CONTRIBUTING.md to help onboard new contributors and establish development standards.

Contents

Getting Started

  • Complete setup instructions
  • Prerequisites and dependencies
  • Initial configuration steps

Development Workflow

  • Branching strategy
  • Making changes
  • Testing locally
  • Commit message conventions
  • Pull request guidelines

Project Structure

  • Detailed directory layout
  • Purpose of each major directory
  • Where to find specific code

Coding Conventions

  • TypeScript best practices
  • React & Next.js patterns
  • Tailwind CSS usage
  • Database operations with Drizzle
  • API route standards

Common Tasks

  • Adding database tables
  • Creating API endpoints
  • Adding new pages
  • Running scripts

Additional Information

  • Testing guidelines (for future)
  • Getting help resources
  • Code of Conduct
  • Security reporting

Benefits

  • Reduces onboarding friction for new contributors
  • Establishes consistent coding standards
  • Documents current project structure
  • Provides clear guidelines for contributions
  • Links to related documentation (README, SECURITY.md)

This serves as a single source of truth for "how to contribute" and complements the existing documentation.

- Document prerequisites and setup steps
- Explain development workflow and branching strategy
- Define pull request guidelines
- Describe project structure and coding conventions
- Provide common development tasks and scripts
- Include security reporting guidelines
- Help onboard new contributors effectively
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