Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.34 KB
Raw

Contributing to Carai

We welcome contributions to Carai! This document outlines the process for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/YourFeatureName
  3. Make your changes
  4. Commit your changes: git commit -m 'Add some feature'
  5. Push to the branch: git push origin feature/YourFeatureName
  6. Submit a pull request

Pull Request Guidelines

  • Ensure your code adheres to the existing style.
  • Include tests for new features or bug fixes.
  • Update documentation as necessary.
  • Describe your changes in detail in the pull request description.

Development Setup

git clone https://github.com/xosnrdev/carai.git
cd carai/web
pnpm install
pnpm dev

Reporting Bugs

Use the GitHub Issues tab to report bugs. Please include:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected and actual results

Feature Requests

We welcome feature requests. Please use the GitHub Issues tab and provide:

  • A clear, descriptive title
  • Detailed description of the proposed feature
  • Any relevant examples or use cases

Questions?

Feel free to open an issue for any questions about contributing.

Thank you for contributing to Carai!