First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project's readme
- Mention the project at local meetups and tell your friends/colleagues
- Contributing to HextaUI
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
We will then take care of the issue as soon as possible.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- If you are looking for support, you might want to check this section).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for HextaUI, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version. \
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most HextaUI users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
Interested in making your first code contribution to the project? here's how you can start with -
- Setup Development Environment: Ensure you have all the necessary dependencies and tools installed to work on the project. Refer to the project's README.md file for instructions on setting up your development environment.
- Selecting an Issue: Look for issues labeled "good first issue" or "enhancements" to find tasks suitable for beginners. You can filter the issues list by these labels to identify opportunities for contribution.
- Making Changes: Once you've selected an issue to work on, fork the repository, create a new branch for your changes, and begin coding. Follow the project's coding standards and guidelines, and consider writing tests if applicable.
- Submitting a Pull Request: After making your changes in the code of the issue opened, commit them to your branch and then push it to your forked repository. Then, submit a pull request to the main repository, by providing a clear explanation of the changes which is made by you and referencing the relevant issue.
Contributing to the documentation is a very valuable way to enhance the project. Here's how you can help this project -
- Updating Existing Documentation: Review the current documentation and suggest improvements or corrections where it's needed. Identify outdated information, inaccuracies, or areas that require clarification.(if any)
- Adding Missing Documentation: Identify any gaps in the documentation and contribute new content to address them. Document any new features or changes introduced to the project to ensure users have comprehensive guidance.
- Correcting Errors: If you encounter any errors or inaccuracies in the documentation, take the initiative to correct them. Ensure that the documentation remains accurate, clear, and helpful for users.
- Documenting New Features: Whenever you introduce a new feature or make significant changes to the project, remember to update the documentation accordingly. Provide detailed explanations and usage examples to help users understand the new functionality.
The project may have specific style guides to follow, such as guidelines for commit messages. Be sure to adhere to these guidelines when contributing to maintain consistency and readability throughout the project.
When making commits to the project, please follow the established guidelines for writing clear, concise and descriptive commit messages. Typically, commit messages should include a short and to the point summary of the changes you made to the project and additional details of the commit if necessary. Consistent and informative commit messages help maintain a clear history of changes and will make collaboration easy with other contributors.
Contributors who demonstrate commitment and expertise may have opportunities to become part of the project team:
- Contributor Recognition: Acknowledge and appreciate the contributions of active and valuable contributors to the project. Recognize their efforts through shoutouts, mentions, or contributor spotlights.
- Becoming a Core Contributor: Exceptional contributors may be invited to join the project team as core contributors. Core contributors have additional responsibilities and privileges within the project.
- Roles and Responsibilities: As a core contributor, you'll be involved in various activities such as code review, issue triaging, and community engagement. Familiarize yourself with your roles and responsibilities within the project team and actively participate in its development.
- Communication Channels: Stay connected with other core contributors and project maintainers through communication channels such as chat platforms, mailing lists, or regular meetings. Collaborate effectively with your team members and contribute to the project's success.
These guidelines will help you navigate your journey from making your first contribution to becoming an integral member of the project team.