Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (36 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 1.48 KB
Raw

Contributing to App Dev Planner

Thank you for your interest in contributing to App Dev Planner.

This project is intended to become an open-source planning workspace for developers, indie hackers, and small teams who want to turn app ideas into structured technical specifications and implementation roadmaps.

Ways to contribute

You can help by:

  • improving documentation;
  • fixing bugs;
  • improving the guided planning questions;
  • adding tests;
  • improving export formats;
  • improving accessibility and UI clarity;
  • proposing new app planning templates;
  • reviewing issues and pull requests.

Local development

npm install
npm run dev

Create a .env.local file with your own Supabase values before testing auth or database-backed flows.

Pull request guidelines

Before opening a pull request:

  1. Keep the scope focused and easy to review.
  2. Explain what changed and why.
  3. Include screenshots for UI changes when useful.
  4. Avoid committing secrets, generated credentials, or local environment files.
  5. Run lint/build checks when possible.

Issue guidelines

When opening an issue, please include:

  • a clear title;
  • expected behavior;
  • actual behavior;
  • steps to reproduce, if reporting a bug;
  • screenshots or screen recordings when helpful;
  • proposed solution, if you already have one.

Good first issues

Good first contribution areas include documentation improvements, question copy improvements, UI clarity, README screenshots, and small export-format refinements.