Thank you for considering contributing to BUI! We are a Tailwind-based React component library designed specifically for building back-office platforms in the real estate industry. BUI is the core UI of several DD360 company products. We value and appreciate all contributions, whether they are small fixes, feature enhancements or issues reports. Feature Highlights
BUI stands out for its focus on performance and lightness compared to other similar libraries on the market. Some notable features include:
Designed for real estate: Our library is specially focused on addressing the needs of the real estate industry, providing a user experience optimized for this domain.
Integrated Tailwind CSS: We export all of Tailwind's CSS, which allows you to use the library without the need to install Tailwind separately. However, if you wish to customize it and use components specific to your project, you have the flexibility to do so.
Complete testing: Each BUI component comes with its own test file to guarantee the quality of the code. We aim to achieve 100% test coverage for the most important functionalities.
Every contribution is welcome and valued! Here are several ways in which you can help improve BUI
Create and resolve issues: If you encounter a problem or have an idea for a new feature, feel free to create an issue in our repository. We will work together to solve it or implement improvements.
Help with PR: If you feel comfortable working with the code, you can help us by submitting Pull Requests (PR) to fix existing issues or add new features.
Give stars and share: If you find our library useful, feel free to give it a star on GitHub and share it with other developers.
Provide feedback: Your opinion is valuable to us. If you have any suggestions or comments, we would love to hear from you to improve BUI.
Use const where possible, otherwise let. Don't use var.
Ignore this if you're specifically writing about ES5.
We use a conventional commits standars, for more information: https://www.conventionalcommits.org/en/v1.0.0/
Strive to keep your commits small and isolated. This helps the reviewer understand what is going on and makes it easier to process your requests.
We have pre-defined templates for everyone, just choose one and use it.
The installation of BUI is simple, and for more information on how to use the library, you can consult our complete documentation at: https://bui.dd360.mx. Acknowledgements
We greatly value the effort and dedication of each contributor in making BUI more scalable and useful for everyone. If you contribute to the project, we will give you appropriate recognition in our BUI portals or in our GitHub repository.
We look forward to your support and collaboration in the growth of BUI!