Contribute
Ways to contribute
First and foremost, we appreciate your interest in contributing to Bolio UI! Your contributions play a crucial role in enhancing the project. Here are various ways you can get involved
-
• Enhance documentation: Address incomplete or missing documentation, improve wording, examples, or explanations.
-
• Provide feedback: We are continually striving to improve Bolio UI. Please share your usage experiences, highlight missing features, and let us know what works well through GitHub Discussions.
-
• Promote Bolio UI: Share links to the Bolio UI documentation with anyone who might find it useful.
-
• Contribute to the codebase: Propose new features by opening GitHub Issues, or take on existing issues that align with your interests.
-
• Conduct a code review: Help us identify issues in the source code or suggest improvements to make Bolio UI more efficient.
How to contribute?
-
• Decide on the contribution you want to make.
-
• For new features, discuss your ideas with the maintainer (via GitHub Discussions) before starting the coding process.
-
• Once issue details are finalized, adhere to commit conventions as you work on the code.
-
• Run tests using
npm testand submit a pull request (pull request) after ensuring all tests pass. -
• Undergo a code review, addressing any issues identified by the maintainer.
-
• If you're unable to complete the task or have a change of plans, no worries! Just inform us in the GitHub issue you initially created. The Bolio UI community is understanding – no judgment or questions if you decide to cancel your submission.
-
• Your pull request gets merged!"
npm scripts
All npm scripts can be found in the main package.json file. Dedicated scripts are not assigned to individual packages.