Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.26 KB

Contributing to Ctrix-Chat-App

First off, thank you for considering contributing to Ctrix-Chat-App! It's people like you that make open source such a great community.

Where do I start?

If you're looking for a place to start, check out the good first issue or help wanted labels in the issues tab.

How to Contribute

  1. Fork the repository

  2. Clone your fork

    git clone https://github.com/your-username/Ctrix-Chat-App.git

  3. Create a new branch

    git checkout -b my-awesome-feature

  4. Install dependencies Since this project uses a pnpm-lock.yaml file, you should use pnpm for installing dependencies.

    pnpm install

  5. Make your changes

  6. Commit your changes

    git commit -m "feat: Add some awesome feature"

  7. Push to your fork

    git push origin my-awesome-feature

  8. Create a pull request Please make sure to raise the pull request against the workspace branch.

Style Guide

Please follow the existing code style. We use Prettier and ESLint to enforce code style, so make sure to run pnpm lint and pnpm format before committing.

Questions?

If you have any questions, feel free to open an issue.