Thank you for your interest in contributing to Composable UI! We appreciate any and all contributions that help make our project better.
Before contributing, please take a moment to review our Code of Conduct. By participating in this project, you agree to abide by its terms.
If you encounter a bug or have a feature request, please submit an issue on our GitHub repository. Please be as detailed as possible in your description, including steps to reproduce the issue and any relevant error messages.
To contribute code to Composable UI, please follow these steps:
- Fork the repository to your own GitHub account
- Clone the repository to your local machine
- Create a new branch for your changes
- Make your changes and test thoroughly
- Submit a pull request back to the original repository
Please make sure your code adheres to our style guide. We also recommend that you write tests for any new functionality.
The following branch prefixes are recommended:
- feat - any new feature
- fix - any bug fix
- chore - any other type of task that is not a new feature or bug fix, for example, updating the README
Please use a verb when defining the name of the task with the following format:
<prefix>/<verb>_<short-description-hyphenated>
Examples:
- feat/implement_reset_password_flow
- fix/_fix_broken_doc_link
- chore/update_readme
For commit messages, please see Conventional Commits for some best-practices.
We welcome contributions to our documentation. If you notice any errors or have suggestions for improvements, please submit a pull request with your changes.
Composable UI follows the Contributor Covenant, version 2.1, as its Code of Conduct. Please review it before contributing.