-
Notifications
You must be signed in to change notification settings - Fork 147
Description
🆕🐥 First Timers Only
This issue is reserved for people who have never contributed to Hiero or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'Good First Issue' is to help you make your first contribution to Hiero.
👾 Description of the issue
Currently, the webpage contains dynamic parts to show all available issues for all contributors.
📋 Step by step guide to do a contribution
If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.
- Claim this issue: Comment below that you are interested in working on the issue
- Wait for assignment: A community member with the given rights will add you as an assignee of the issue
- Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
- Check out the forked repository
- Create a feature branch for the issue. Please prefix the branch name with the issue id.
- Start solving the issue in your branch.
- Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org/). More details can be found in our CONTRIBUTING.md
- Start a Draft Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
- Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hiero developer community for support.
- When all checks are passing and you're happy with your solution, convert the Draft PR into a PR ask for reviews.
- Wait for reviews: Members of the Hiero developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hiero community as an open-source contributor ❤️
🤔 Additional Information
If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.