CONTRIBUTING.md

Contributing to client.dev

Thank you for your interest in contributing! We welcome contributions from the community.

How to Contribute

• Bug Reports & Feature Requests:

  • Open an issue describing the bug or feature request.
  • Please provide as much detail as possible, including steps to reproduce bugs.

• Pull Requests:

  • Fork the repository and create your branch from main.
  • Write clear, concise commit messages.
  • Ensure your code follows our coding standards (see below).
  • Add or update tests as appropriate.
  • Open a pull request and describe your changes.

Coding Standards

• Use ESLint and Prettier for code style and formatting.
• Write clear, maintainable, and well-documented code.
• Use descriptive variable and function names.
• Add comments where necessary.

Running Locally

1. Clone the repository

2. Install dependencies:

   nvm use
   npm install

3. Run tests:

   npm run test

4. Start the example app:

   npm run build && npm run dev -w example

Code of Conduct

This project follows the Contributor Covenant Code of Conduct.