Skip to main content

Contributing to CH-UI 🙌

You are awesome!

Thank you for looking into contributing to CH-UI! Your contributions are essential for making this project better. Whether you're fixing a bug, creating a new feature, or improving documentation, we appreciate your effort.

How to Contribute​

Reporting Bugs 🐛​

If you find a bug, please create an issue in our GitHub repository.

Make sure to include:

  1. A clear title describing the bug
  2. Steps to reproduce the issue
  3. Expected vs. actual behavior
  4. Any relevant error messages or logs

Requesting Features 💡​

Have an idea for a new feature? Create a feature request with:

  1. A clear description of the feature
  2. Why it's needed or how it improves CH-UI
  3. Any additional context or mockups if available

Improving Documentation 📚​

info

Who in the world doesn't want good documentation!? If you find typos, missing information, or want to expand a section, feel free to submit a pull request.

Code Contributions 💻​

Follow these steps to contribute code:

  1. Fork the repository to your GitHub account or clone it directly:
git clone https://github.com/caioricciuti/ch-ui.git
cd ch-ui
  1. Create a new branch for your contribution:
git checkout -b feature/my-new-feature
  1. Write your code and commit your changes:
git commit -m "Add new feature"
  1. Push to your fork and open a Pull Request:
git push origin feature/my-new-feature
  1. Open a pull request from your fork's branch to main on the CH-UI repository.

Development Setup​

Setting Up the Environment​

  1. Clone the repository:
git clone https://github.com/your-org/ch-ui.git
cd ch-ui
  1. Install dependencies and start the development server:
npm install
npm run dev
  1. Access the app locally at http://localhost:5173

Code Style Guidelines​

To maintain consistency across the codebase:

  • Follow the existing code patterns
  • Ensure your code is well-documented with comments where necessary
  • Run the linter before committing:
npm run lint

Testing Requirements​

Before submitting a pull request:

  1. Run all tests to ensure no existing functionality is broken:
npm test
  1. Write tests for any new features you add

Community and Support 👥​

  • Join our Slack channel for discussions
  • Use GitHub Issues for bug reports and feature requests
  • Participate in GitHub Discussions for general topics

License 📄​

By contributing to CH-UI, you agree that your contributions will be licensed under the same license as CH-UI. Check the LICENSE file for more information.

Thank You! ❤️​

Thank you for being part of the CH-UI community. Together, we can build something incredible!

note

Need help getting started? Feel free to reach out to the community through any of our communication channels.