Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.04 KB

File metadata and controls

29 lines (20 loc) · 1.04 KB

Contributing

Thank you for your interest in improving MiniFy. Please follow these guidelines to keep contributions smooth and maintainable.

How to Contribute

  • Discuss first: Open an issue for bugs or feature ideas before starting work.
  • Scope small: Prefer focused pull requests that solve one problem.
  • Follow style: Match the existing code style and patterns; avoid introducing new frameworks or patterns without discussion.
  • Testing: Include relevant tests or manual verification steps when possible.

Development Setup

  • Install dependencies: pnpm install.
  • Desktop dev: pnpm desktop:dev.
  • Web dev: pnpm www:dev.
  • Lint: pnpm lint.

Pull Requests

  • Keep changes minimal and purposeful.
  • Update documentation only when it directly relates to the change.
  • Ensure the PR description explains the problem, the solution, and how to test.
  • Link related issues or roadmap items when applicable.

Communication

  • Be concise and respectful.
  • If something blocks you, describe what you tried and where you are stuck.