Skip to content

Contributing

DonFlow is open source and we welcome contributions!

Repository

GitHub: github.com/maxmini0214/donflow

Quick Start

bash
git clone https://github.com/maxmini0214/donflow.git
cd donflow
npm install
npm run dev

The app runs at http://localhost:5173/donflow/.

Ways to Contribute

🐛 Bug Reports

Found a bug? Open an issue with:

  • What you expected to happen
  • What actually happened
  • Browser and OS info
  • Steps to reproduce

💡 Feature Requests

Have an idea? Open an issue and describe:

  • The problem you're trying to solve
  • How you'd like it to work
  • Why it fits DonFlow's philosophy (browser-only, zero-tracking)

🔧 Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Test locally (npm run dev)
  5. Submit a PR with a clear description

Guidelines

  • Keep it client-side — No server dependencies, no API calls, no analytics
  • Keep it simple — DonFlow's strength is focus, not feature count
  • Keep it private — No tracking, no telemetry, no data collection of any kind

Documentation

This docs site lives in /docs-site/. To develop locally:

bash
cd docs-site
npm install
npm run docs:dev

License

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

Released under the MIT License.