Contribution Basics

This topic provides the guidelines to follow when you contribute to Composable UI.

Getting Started

Before contributing, review the following guides:

• The Code of Conduct and the Contributor Covenant version 2.1.

By participating in this project, you agree to abide by the terms in these guides.

Reporting Issues

• To report a bug or request a feature, submit an issue in the Composable UI GitHub repository.

Ensure that you add all required details in your description, including steps to reproduce the issue and any relevant error messages.

Contributing Code

• Ensure that your code adheres to our style guide.

To contribute code to Composable UI:

1. Fork the repository to your GitHub account.

2. Clone the repository to your local machine.

3. Create a new branch to make changes.

4. Make your changes and test thoroughly.

   We recommend that you write tests for any new functionality.

5. Submit a pull request to the Composable UI GitHub repository.

Branch and Commit Strategy

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 a bug fix, such as, updating the README file.

Use a verb when defining the name of the task as in the following format:

<prefix>/<verb>_<short-description-hyphenated>

For example:

• feat/implement_reset_password_flow
• fix/_fix_broken_doc_link
• chore/update_readme

For commit messages and best practices, see Conventional Commits.

Contributing Documentation

If you notice any errors in the documentation or have suggestions for improvements, submit a pull request with your changes.