-
Notifications
You must be signed in to change notification settings - Fork 24
Description
🆕🐥 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
The code already cotains the com.openelements.hedera.base.NftRepository interface that acts as a rapper around REST calls against a Mirror Node. Here only some specific of the REST endpoints that are provided by a Mirror Node are used. A full documentation of the REST API can be found here. Next to that Hedera provides a Swagger UI for specific mirror nodes. The Swagger UI for the Mirror Node of the Hedera testnet can be found here.
As you can see in the documentation and Swagger UI the Mirror Node expose a lot of information. Some of this information is specific to network information and for that an NetworkRepository interface should be defined that is similar to the NftRepository.
Next to the interface definition an implementation (see NftRepositoryImpl class for reference) and unit tests must be created.
📋 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
- 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. You can join the Hedera community chat at Discord. A general manual about open-source contributions can be found here.