Contributing

We're excited that you're interested in contributing to React Utilities! This document will guide you through the process of adding new components or improving existing ones.

Getting Started

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Install dependencies with npm install.
4. Create a new branch for your feature or bug fix.

Adding a New Utility Component

1. Create a new file in the appropriate directory (e.g., src/components/NewUtility.tsx).
2. Implement your utility component, following the existing code style and best practices.
3. Add tests for your component in the tests directory.
4. Update the main export file to include your new component.
5. Create a documentation file in pages/content/new-utility.md.

Documentation Guidelines

When creating or updating documentation:

1. Use clear, concise language to explain the purpose and usage of the utility.
2. Provide code examples demonstrating common use cases.
3. Explain any props or configuration options available for the component.
4. Include information about edge cases or potential pitfalls.

Pull Request Process

1. Ensure your code follows the project's coding standards and passes all tests.
2. Update the README.md with details of your changes, if applicable.
3. Create a pull request with a clear title and description of your changes.
4. Wait for a maintainer to review your pull request. Address any feedback or questions they may have.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions?

If you have any questions about contributing, feel free to open an issue or reach out to the maintainers on Twitter @broisnees.

Thank you for contributing to React Utilities!