Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (31 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

40 lines (31 loc) · 1.28 KB

Contributing to Astro Feature Map

Thank you for your interest in contributing to Astro Feature Map! We welcome all kinds of contributions, from bug reports to new features.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/astro-feature-map.git
cd astro-feature-map
  3. Install dependencies: 
    pnpm install
  4. Setup local database: 
    pnpm db:migrate:local
  5. Start development server: 
    pnpm dev

Development Workflow

  • Branching: Create a new branch for your feature or bug fix (e.g., feat/add-webhook or fix/nav-typo).
  • Code Style: We use Prettier and ESLint. Please run pnpm format before committing.
  • Testing: Run pnpm test (unit) and pnpm test:e2e (E2E) to ensure no regressions.
  • Pull Requests: Submit your PR against the main branch. Provide a clear description of your changes.

Bug Reports & Feature Requests

  • Use GitHub Issues to report bugs or suggest enhancements.
  • For feature ideas, you can also post them on our Public Roadmap.

License

By contributing, you agree that your contributions will be licensed under the MIT License.