-
Notifications
You must be signed in to change notification settings - Fork 72
Description
This issue is reserved for people who have never or only recently 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
Users that work on multiple issues or create branches from other branches sometimes submit a pull request with two issues in one.
We only allow one issue per pull request.
We should add a new subtitle contents in common_issues.md called "One Issue Per Pull Request"
We should write an explanation of the problem in "One Issue Per Pull Request" and how to solve it.
💡 Solution
Create "One Issue Per Pull Request" subtitle and contents.
Explain:
- We only accept one issue per pull request
give an example
e.g.
if your issue is "Expand Token Creation to allow Infinite tokens", ONLY try to create a pull request with "Expand Token Creation to allow Infinite tokens" and its changelog entry of "feat: added infinite tokens to token create". DO NOT add type hints to token_associate.py and its changelog entry of "chore: type hint token associate"
Solve the issue:
- To solve this, we need to confirm to people best practices
- They should always create a branch, ONE PER pull request and it should be a branch from main
- Even if they have worked on another pull request! It should always be a fresh branch from main
- Remind users to ensure their main is up to date with the upstream main, i think we have instructions in rebasing.md how to do that. Ensure they git pull any changes.
Explain to users once they submit their pull request they can see what files their pull request changes.
for example
https://github.com/hiero-ledger/hiero-sdk-python/pull/515/files
They need to make sure ONLY the files that are relevant for the pull request are changed, otherwise it cannot meet the merge criteria.
👩💻 Implementation
- Expand common_issues.md with "One Issue Per Pull Request"
- Add explanation on the cause and solution and how to check
Note: common_issues.md is located at
examples/sdk_developers/common_issues.md
OR
docs/sdk_developers/common_issues.md
depending on when you submit the PR.
Acceptance Criteria:
- Content in common_issues.md is otherwise the same
- New sub section
- New explanation
👩💻 Requirements to Pass
- Descriptive changelog.md addition to 'UNRELEASED' under 'changed':
e.g.
"refactored examples/topic_message_submit.py to be more modular"
NOTE: ensure your branch is always up to date with upstream main !! - Verified commits achieved (see CONTRIBUTING.md and docs/sdk_developers/signing.md)
IMPORTANT Your pull request CANNOT BE MERGED until you add a changelog entry AND sign your commits each with "git commit -S -s -m "chore: your commit message"" and a GPG key***
Next steps
- Comment below that you’d like to work on this issue.
- Wait to be assigned by a maintainer.
- Read CONTRIBUTING.md
to start forking and developing.
If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow.
We also have a helpful docs archives at: /docs/sdk_developers
https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers
and further information on signing here
https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md