Contributing to Rad UI is a great way to get involved in the project and help us improve the library. There are many ways to contribute, from fixing bugs, adding new features, improving documentation, and more. We value all contributions and are grateful for your help.
If you're unsure about what to contribute on, feel free to take your time exploring the repository.
You can also support us by starring the repository on GitHub.
We have an active and a friendly community on Discord. Join us to get help, discuss ideas, and share your work.
Join the DiscordWe've triaged issues in our GitHub issues to make it easier to find an issue for contributors to work on.
If you're getting started, don't know where to start, Good First Issues are a great place to start.
Note: Before you start working on an issue, please make sure to comment on the issue to let others know that you're working on it. This helps avoid duplicate work and ensures that your changes are not conflicting with other changes. If you have any questions, please ask in the issue or on Discord. We'll be happy to help you get started and support you in any way we can.
Create a new branch for your changes. You can name your branch with a very brief description of the changes you're making. You can prefix it with your name/GitHub username to make it easier to identify and avoid conflicts. For example: (yourname)/fix-issue-123
Follow the issue description and make your changes.
Commit your work with a clear message - you can use the following prefixes:
For Fixes : git commit -m "Fix: <description>"
For Features : git commit -m "Feature: <description>"
For Documentation : git commit -m "Docs: <description>"
For Refactoring : git commit -m "Refactor: <description>"
For Chore : git commit -m "Chore: <description>"
For Style : git commit -m "Style: <description>"
For Performance : git commit -m "Performance: <description>"
For Test : git commit -m "Test: <description>"
For CI : git commit -m "CI: <description>"
We have a comprehensive test suite for Rad UI. If you're adding new features or fixing bugs, please add tests for your changes where applicable. Writing good tests is a great way to ensure your changes are working as expected.
Verify your changes manually if tests are not applicable.
Raise a Pull Request to the main branch.
Make sure to include a description of your changes and any relevant information.
If you're fixing an issue, make sure to reference the issue number in the description. If you're adding a new feature, make sure to include a description of the feature and how it works. If your PR has a lot of visual changes, please include screenshots or a video demonstrating the changes or additions.
We'll review your PR and provide feedback. If there are any changes required, we'll let you know.
Once your PR is approved, we'll merge it into the main branch.
Congratulations! You've contributed to Rad UI. This is just a first step. We'll be happy to have you as a contributor and work together to make Rad UI better.