Thank you for your interest in contributing to Biee-Ui!
React Ui library with Various reusable components.
The following is a set of guidelines for contributing to the project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
- Fork the repository on GitHub.
- Clone the forked repository to your local machine using the git clone command in your terminal.
- Create a new branch to work on using git checkout -b
<branch-name>. - Make your changes and commit them using git commit -m
<commit-message>. - Push your changes to your forked repository on GitHub using git push origin
<branch-name>. - Create a pull request on the original repository's GitHub page, detailing your changes.
- Wait for maintainers to review and merge your changes, or provide feedback for further improvement.
Please follow these code style guidelines when contributing to the project:
- Use four spaces for indentation.
- Use camelCase for variable and function names.
- Use PascalCase for class and component names.
- Use descriptive, concise variable and function names.
- Use meaningful comments to explain complex code.
- Avoid hardcoding values whenever possible.
Please follow these commit message guidelines:
- Use present tense in your commit messages.
- Start your commit message with a verb (e.g. "Fix bug" instead of "Fixed bug").
- Keep your commit message concise and descriptive.
- Reference any relevant issues in your commit message.
Please follow these issue guidelines:
- Search the issues before creating a new one to avoid duplicates.
- Be clear and descriptive in your issue title and description.
- Include steps to reproduce the issue, if applicable.
- Provide any relevant screenshots or error messages.
If you have any questions or need help with your contribution, please feel free to reach out to us via Bieefilled.
We appreciate all contributions to the project, and we look forward to working with you!