Skip to content

Commit 4dfc115

Browse files
authored
fix: update broken documentation links and enhance CONTRIBUTING.md (#445)
- Convert absolute GitHub uel to relative paths in CONTRIBUTING.md as asked - Update all documentation references to use local paths instead of pointing to hiero-sdk project hub - Add changelog entries for documentation link fixes - Improve relative links throughout the documentation Signed-off-by: BhuvanB404 <[email protected]>
1 parent ee0814d commit 4dfc115

File tree

2 files changed

+104
-11
lines changed

2 files changed

+104
-11
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
5353
- `_parse_custom_fees`
5454
Kept robust versions with proper docstrings and error handling.
5555
- Add strict type hints to `TransactionGetReceiptQuery` (#420)
56+
- Fixed broken documentation links in CONTRIBUTING.md by converting absolute GitHub URLs to relative paths
57+
- Updated all documentation references to use local paths instead of pointing to hiero-sdk project hub
5658

5759
## [0.1.5] - 2025-09-25
5860

CONTRIBUTING.md

Lines changed: 102 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,97 @@ Workflow:
4747

4848
**Note**: each push to your branch will add to the draft pull request.
4949

50-
6. **Ensure Branch is Updated With Upstream Main**. Follow these steps to make sure your branch is up-to-date with main to avoid conflicts [Updating Your Branch](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/rebasing.md).
50+
6. **Ensure Branch is Updated With Upstream Main**. Follow these steps to make sure your branch is up-to-date with main to avoid conflicts [Updating Your Branch](docs/sdk_developers/rebasing.md).
5151

52-
7. **Solve your issue on this branch**: code the solution and push commits progressively to your branch.
53-
To ensure high-quality-reviewable code, please ensure:
52+
7. **Solve your issue on this branch**: code the solution and push commits progressively to your branch.
53+
To ensure high-quality-reviewable code, please ensure:
54+
- [ ] Update the changelog at CHANGELOG.md with your feature or bug fix.
55+
- [ ] Only resolve tasks set. For example, if the issue is to code a Token create unit test, do not change the style in TokenCreateTransaction or update the integration tests. To resolve additional tasks, create a [New Feature](#feature-requests) and create an additional Pull Request.
56+
- [ ] Add type hints and check using mypy [Typing Guide](docs/sdk_developers/types.md)
57+
- [ ] Style and lint using pylint [Linting Guide](docs/sdk_developers/linting.md)
58+
- [ ] Test your code. Create unit tests (local) at tests/unit and integration tests (network) at tests/integration [Testing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/README.md). Run tests and fix code.
59+
- [ ] Write functionality example(s) if applicable at examples/ [View Examples](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/examples).
60+
- [ ] Update README at docs/sdk_users/running_examples.md if you added an example script(s)
5461

55-
- [ ] Update the changelog at [CHANGELOG.md](https://github.com/DinethShakya23/hiero-sdk-python/blob/main/CHANGELOG.md) with your feature or bug fix.
56-
- [ ] Only resolve tasks set. For example, if the issue is to code a Token create unit test, do not change the style in TokenCreateTransaction or update the integration tests. To resolve additional tasks, create a [New Feature](#feature-requests) and create an additional Pull Request.
57-
- [ ] Add type hints and check using mypy [Typing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/types.md)
58-
- [ ] Style and lint using pylint [Linting Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/linting.md)
59-
- [ ] Test your code. Create unit tests (local) at hedera_sdk_python/tests/unit and integration tests (network) at hedera_sdk_python/tests/integration [Testing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/README.md). Run tests and fix code.
60-
- [ ] Write functionality example(s) if applicable at hedera_sdk_python/examples [View Examples](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/examples).
61-
- [ ] Update README at hedera_sdk_python/examples/README.md if you added an example script(s)
62+
### Signing Requirements
63+
8. **IMPORTANT: All commits MUST be signed and verified!**
64+
65+
66+
67+
Every commit you make must be:
68+
- **GPG Signed** with `-S` flag
69+
- **DCO Signed** with `-s` flag
70+
- **Verified** by GitHub (shows green "Verified" badge)
71+
72+
**Correct commit command:**
73+
```bash
74+
git commit -S -s -m "feat: your commit message"
75+
```
76+
77+
**What this means:**
78+
- `-S` = GPG signature (proves you authored the commit)
79+
- `-s` = DCO sign-off (agrees to Developer Certificate of Origin)
80+
- Both are required for your PR to be accepted
81+
82+
**If you forget to sign a commit:**
83+
```bash
84+
git commit --amend -S -s
85+
git push --force-with-lease
86+
```
87+
88+
**Setup help:** See our detailed guide for instructions on adding **GPG** keys and signing [Signing Guide](docs/sdk_developers/signing.md)
89+
90+
91+
9. **Ensure Branch is Updated**. Check if main has been updated since you started work. If it has, rebase by following the steps given in [Updating Your Branch](docs/sdk_developers/rebasing.md). Resolve any conflicts.
92+
93+
10. **Run tests**. Run unit tests and integration tests depending on your changes . Resolve any errors.
94+
95+
11. **Review Network Test Outcomes**. Once your issue is solved on your branch, publish your branch and visit your forked python sdk repository. Your push will trigger Hiero Solo Integration Tests which is our network test suite. Resolve issues and fix any code in your own fork before flagging a PR to main repo.
96+
97+
12. **Change Pull Request From Draft to 'Ready to Review'**. Visit your draft pull request at [Pull Requests](https://github.com/hiero-ledger/hiero-sdk-python/pulls). Convert it to 'Ready to Review' by clicking the button at the bottom of the page.
98+
99+
13. **Wait for Workflow Outcomes and Reviews**. Our maintainers will be notified automatically of your pull request and provide feedback.
100+
101+
14. **Update Code Given Feedback**. Create additional commits to resolve applicable feedback and ask for a review once completed.
102+
103+
15. **Wait for Merging to Main**. When your pull request is approved, it will shortly be merged into main. Congratulations and thank you!
104+
105+
106+
### Changelog Requirements
107+
108+
**Update CHANGELOG.md for every contribution!**
109+
110+
You must add your changes to the `[Unreleased]` section at the top of `CHANGELOG.md`:
111+
112+
```markdown
113+
## [Unreleased]
114+
115+
### Added
116+
- Your new feature description
117+
118+
### Fixed
119+
- Your bug fix description
120+
121+
### Changed
122+
- Your improvement description
123+
```
124+
125+
**Requirements:**
126+
- Add one sentence describing what you changed
127+
- Place it in the correct category (Added/Fixed/Changed/Removed)
128+
- Keep it concise but descriptive
129+
- This helps users understand what's new in each release
130+
131+
### Code Quality Requirements
132+
133+
To ensure high-quality-reviewable code, please ensure:
134+
- [ ] Update the changelog at CHANGELOG.md with your feature or bug fix.
135+
- [ ] Only resolve tasks set. For example, if the issue is to code a Token create unit test, do not change the style in TokenCreateTransaction or update the integration tests. To resolve additional tasks, create a [New Feature](#feature-requests) and create an additional Pull Request.
136+
- [ ] Add type hints and check using mypy [Typing Guide](docs/sdk_developers/types.md)
137+
- [ ] Style and lint using pylint [Linting Guide](docs/sdk_developers/linting.md)
138+
- [ ] Test your code. Create unit tests (local) at tests/unit and integration tests (network) at tests/integration [Testing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/README.md). Run tests and fix code.
139+
- [ ] Write functionality example(s) if applicable at examples/ [View Examples](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/examples).
140+
- [ ] Update README at docs/sdk_users/running_examples.md if you added an example script(s)
62141

63142
8. **Ensure Quality of Commits**. Each individual commit should be:
64143

@@ -71,14 +150,22 @@ Workflow:
71150

72151
11. **Change Pull Request From Draft to 'Ready to Review'**. Visit your draft pull request at [Pull Requests](https://github.com/hiero-ledger/hiero-sdk-python/pulls). Convert it to 'Ready to Review' by clicking the button at the bottom of the page.
73152

153+
### Bad Practices
154+
155+
- Dont Merge main into your branch (use rebase instead) - see [merge conflicts guide](docs/sdk_developers/merge_conflicts.md)
156+
- Dont Make unrelated changes in the same PR
157+
- Dont Force push without `--force-with-lease`
158+
- Dont Include sensitive information (API keys, passwords, etc.)
159+
- Dont skip commit signing
160+
74161
Ensure:
75162

76163
- [ ] You've explained the changes in your pull-request.
77164
- [ ] CHANGELOG.md is updated
78165
- [ ] Your pull request has a title with a pre-fix such as [conventional title formatting](https://www.conventionalcommits.org/en/v1.0.0/)
79166
- [ ] Local unit tests pass.
80167
- [ ] Hiero Solo Integration Tests pass.
81-
- [ ] All commits are marked as verified. If not, you'll need to back-sign [Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md).
168+
- [ ] All commits are marked as verified. If not, you'll need to back-sign [Signing Guide](docs/sdk_developers/signing.md).
82169
- [ ] No sensitive information is revealed.
83170

84171
12. **Wait for Workflow Outcomes and Reviews**. Our maintainers will be notified automatically of your pull request and provide feedback.
@@ -203,6 +290,10 @@ We strive to be a welcoming community with lots of activity, opportunities and s
203290

204291
The Hiero Python SDK provides comprehensive documentation for both developers and users. All SDK documentation is organized in the `/docs` folder. Below is an overview to help you navigate it.
205292

293+
- Review our collection of first starter documentation: README.md, Contributing.md, [Signing Guide](docs/sdk_developers/signing.md), [Linting Guide](docs/sdk_developers/linting.md), [Types Guide](docs/sdk_developers/types.md).
294+
- View examples of our code at examples/
295+
- View our codebase at src/hiero_sdk_python/
296+
206297
#### 1. Hedera Services
207298

208299
Resources for understanding the Hedera network and its services:

0 commit comments

Comments
 (0)