Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 3.07 KB

GOOD_FIRST_ISSUE_TEMPLATE.md

File metadata and controls

38 lines (26 loc) · 3.07 KB

Good First Issue Template

The following text should be used as a template for all issues that are labeled by 'good first issue':

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to this project 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.

👾 Description of the issue

[THIS CHAPTER SHOULD CONTAIN THE DESCRIPTION OF THE ISSUE AND IS INDIVIDAL FOR EACH ISSUE]

📋 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. 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. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: to your branch. Here it is important to sign-off you commits to fullfill the Developer Certificate of Origin (DCO). More information can be found in our contribution guideline.
  • Start a Pull Request (PR): in the hedera-enterprise repository
  • 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 community for support.
  • Wait for reviews: Members of the 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 our community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional informantion

If you have any questions, just ask us directly in this issue by adding a comment. A general manual about open-source contributions can be found here.