Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.06 KB

Contributing to Boxflow

First off, thanks for taking the time to contribute! Boxflow is built for the community, and we appreciate your help in making it better.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Install pnpm.
  4. Run pnpm install to install dependencies.
  5. Create a new branch for your feature or fix.
  6. Run the development server with watch mode: pnpm run dev.

Implementation Details

  • React: The UI is built with React 19.
  • Styles: Use the Material 3 design tokens defined in styles.css.
  • Data: We use a hidden code block (```boxflow ... ```) to store structured data. Ensure your changes maintain data integrity during parsing.

Submitting Changes

  1. Ensure your code passes linting: pnpm run lint.
  2. Commit your changes with clear, descriptive messages following Conventional Commits.
  3. Push to your fork and submit a Merge Request on GitLab.

Code of Conduct

Be kind, keep it simple, and focus on the user experience.

Thank you for being part of Boxflow!