Skip to content

Commit 4d1f492

Browse files
committed
Move docs/sdk_developers/changelog_entry.md, checklist.md, merge_conflicts.md, signing.md, testing.md todocs/sdk_developers/training/workflow
1 parent db04ee4 commit 4d1f492

17 files changed

+32
-32
lines changed

.github/ISSUE_TEMPLATE/01_good_first_issue.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,8 @@ body:
229229
EDIT OR EXPAND THE CHECKLIST ON WHAT IS REQUIRED TO BE ABLE TO MERGE A PULL REQUEST FOR THIS ISSUE
230230
value: |
231231
To be able to merge a pull request for this issue, we need:
232-
- [ ] **Changelog Entry:** Correct changelog entry (please link to the documentation - [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md))
233-
- [ ] **Signed commits:** commits must be DCO and GPG key signed ([see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md))
232+
- [ ] **Changelog Entry:** Correct changelog entry (please link to the documentation - [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/changelog_entry.md))
233+
- [ ] **Signed commits:** commits must be DCO and GPG key signed ([see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/signing.md))
234234
- [ ] **All Tests Pass:** our workflow checks like unit and integration tests must pass
235235
- [ ] **Issue is Solved:** The implementation fully addresses the issue requirements as described above
236236
- [ ] **No Further Changes are Made:** Code review feedback has been addressed and no further changes are requested
@@ -248,8 +248,8 @@ body:
248248
- [ ] **Claim this issue:** Comment below that you are interested in working on the issue. Without assignment, your pull requests might be closed and the issue given to another developer.
249249
- [ ] **Wait for assignment:** A community member with the given rights will add you as an assignee of the issue
250250
- [ ] **Fork, Branch and Work on the issue:** Create a copy of the repository, create a branch for the issue and solve the problem. For instructions, please read our [Contributing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/CONTRIBUTING.md) file. Further help can be found at [Set-up Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/setup) and [Workflow Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/workflow).
251-
- [ ] **DCO and GPG key sign each commit :** each commit must be -s and -S signed. An explanation on how to do this is at [Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md)
252-
- [ ] **Add a Changelog Entry :** your pull request will require a changelog. Read [Changelog Entry Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md) to learn how.
251+
- [ ] **DCO and GPG key sign each commit :** each commit must be -s and -S signed. An explanation on how to do this is at [Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/signing.md)
252+
- [ ] **Add a Changelog Entry :** your pull request will require a changelog. Read [Changelog Entry Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/changelog_entry.md) to learn how.
253253
- [ ] **Push and Create a Pull Request :** Once your issue is resolved, and your commits are signed, and you have a changelog entry, push your changes and create a pull request. Detailed instructions can be found at [Submit PR Training](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/11_submit_pull_request.md), part of [Workflow Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/workflow).
254254
- [ ] **You did it 🎉:** A maintainer or committer will review your pull request and provide feedback. If approved, we will merge the fix in the main branch. Thanks for being part of the Hiero community as an open-source contributor ❤️
255255

.github/ISSUE_TEMPLATE/04_good_first_issue_candidate.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ body:
238238
value: |
239239
To be able to merge a pull request for this issue, we need:
240240
- [ ] **Changelog Entry:** Correct changelog entry (please link to the documentation - [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md))
241-
- [ ] **Signed commits:** commits must be DCO and GPG key signed ([see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md))
241+
- [ ] **Signed commits:** commits must be DCO and GPG key signed ([see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/signing.md))
242242
- [ ] **All Tests Pass:** our workflow checks like unit and integration tests must pass
243243
- [ ] **Issue is Solved:** The implementation fully addresses the issue requirements as described above
244244
- [ ] **No Further Changes are Made:** Code review feedback has been addressed and no further changes are requested
@@ -256,8 +256,8 @@ body:
256256
- [ ] **Claim this issue:** Comment below that you are interested in working on the issue. Without assignment, your pull requests might be closed and the issue given to another developer.
257257
- [ ] **Wait for assignment:** A community member with the given rights will add you as an assignee of the issue
258258
- [ ] **Fork, Branch and Work on the issue:** Create a copy of the repository, create a branch for the issue and solve the problem. For instructions, please read our [Contributing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/CONTRIBUTING.md) file. Further help can be found at [Set-up Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/setup) and [Workflow Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/workflow).
259-
- [ ] **DCO and GPG key sign each commit :** each commit must be -s and -S signed. An explanation on how to do this is at [Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md)
260-
- [ ] **Add a Changelog Entry :** your pull request will require a changelog. Read [Changelog Entry Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md) to learn how.
259+
- [ ] **DCO and GPG key sign each commit :** each commit must be -s and -S signed. An explanation on how to do this is at [Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/signing.md)
260+
- [ ] **Add a Changelog Entry :** your pull request will require a changelog. Read [Changelog Entry Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/changelog_entry.md) to learn how.
261261
- [ ] **Push and Create a Pull Request :** Once your issue is resolved, and your commits are signed, and you have a changelog entry, push your changes and create a pull request. Detailed instructions can be found at [Submit PR Training](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/11_submit_pull_request.md), part of [Workflow Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/workflow).
262262
- [ ] **You did it 🎉:** A maintainer or committer will review your pull request and provide feedback. If approved, we will merge the fix in the main branch. Thanks for being part of the Hiero community as an open-source contributor ❤️
263263

.github/workflows/bot-merge-conflict.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
Please resolve these conflicts locally and push the changes.
5454
5555
To assist you, please read:
56-
- [Resolving Merge Conflicts](docs/sdk_developers/merge_conflicts.md)
56+
- [Resolving Merge Conflicts](docs/sdk_developers/training/workflow/merge_conflicts.md)
5757
- [Rebasing Guide](docs/sdk_developers/rebasing.md)
5858
5959
Thank you for contributing!

.github/workflows/bot-verified-commits.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
View your commit verification status: [Commits Tab]($COMMITS_URL).
5454

5555
To achieve verified status, please read:
56-
- [Signing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md)
56+
- [Signing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/signing.md)
5757
- [README](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/README.md)
5858
- [Discord](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/discord.md)
5959

.github/workflows/bot-workflows.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ jobs:
5050
Your pull request cannot be merged as it is not passing all our workflow checks.
5151
Please click on each check to review the logs and resolve issues so all checks pass.
5252
To help you:
53-
- [DCO signing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md)
54-
- [Changelog guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md)
55-
- [Merge conflicts guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/merge_conflicts.md)
53+
- [DCO signing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/signing.md)
54+
- [Changelog guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/changelog_entry.md)
55+
- [Merge conflicts guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/merge_conflicts.md)
5656
- [Rebase guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/rebasing.md)
57-
- [Testing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/testing.md)
57+
- [Testing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/testing.md)
5858
- [Discord](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/discord.md)
5959
- [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meetings/hiero?view=week)
6060
Thank you for contributing!

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -679,7 +679,7 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
679679

680680
### Changed
681681

682-
- N/A
682+
- Move docs/sdk_developers/changelog_entry.md, checklist.md, merge_conflicts.md, signing.md, testing.md to docs/sdk_developers/training/workflow
683683

684684
### Fixed
685685

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ Thank you for your interest in contributing to the Hiero Python SDK!
2929
4. Submit a PR
3030

3131
**Requirements:**
32-
- Signed commits (GPG + DCO) - [Signing Guide](docs/sdk_developers/signing.md)
33-
- Updated changelog - [Changelog Guide](docs/sdk_developers/changelog_entry.md)
32+
- Signed commits (GPG + DCO) - [Signing Guide](docs/sdk_developers/training/workflow/signing.md)
33+
- Updated changelog - [Changelog Guide](docs/sdk_developers/training/workflow/changelog_entry.md)
3434
- Tests pass
35-
- Code quality checks - [Checklist](docs/sdk_developers/checklist.md)
35+
- Code quality checks - [Checklist](docs/sdk_developers/training/workflow/checklist.md)
3636

3737

3838
#### ⚠️ A Note on Breaking Changes
@@ -94,11 +94,11 @@ We welcome blog posts! Whether you're sharing a tutorial, case study, or your ex
9494
|-------|----------------|
9595
| [Setup](docs/sdk_developers/setup.md) | Fork, clone, install, configure |
9696
| [Workflow](docs/sdk_developers/workflow.md) | Branching, committing, PRs |
97-
| [Signing](docs/sdk_developers/signing.md) | GPG + DCO commit signing |
98-
| [Changelog](docs/sdk_developers/changelog_entry.md) | Writing changelog entries |
99-
| [Checklist](docs/sdk_developers/checklist.md) | Pre-submission checklist |
97+
| [Signing](docs/sdk_developers/training/workflow/signing.md) | GPG + DCO commit signing |
98+
| [Changelog](docs/sdk_developers/training/workflow/changelog_entry.md) | Writing changelog entries |
99+
| [Checklist](docs/sdk_developers/training/workflow/checklist.md) | Pre-submission checklist |
100100
| [Rebasing](docs/sdk_developers/rebasing.md) | Keeping branch updated |
101-
| [Merge Conflicts](docs/sdk_developers/merge_conflicts.md) | Resolving conflicts |
101+
| [Merge Conflicts](docs/sdk_developers/training/workflow/merge_conflicts.md) | Resolving conflicts |
102102
| [Types](docs/sdk_developers/types.md) | Python type hints |
103103
| [Linting](docs/sdk_developers/linting.md) | Code quality tools |
104104

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ print(f"Balance: {balance.hbars} HBAR")
6464
- **[Contributing Guide](CONTRIBUTING.md)** - Start here!
6565
- **[Setup Guide](docs/sdk_developers/setup.md)** - First-time environment setup
6666
- **[Workflow Guide](docs/sdk_developers/workflow.md)** - Day-to-day development workflow
67-
- **[Signing Guide](docs/sdk_developers/signing.md)** - GPG and DCO commit signing (required)
68-
- **[Changelog Guide](docs/sdk_developers/changelog_entry.md)** - How to write changelog entries
67+
- **[Signing Guide](docs/sdk_developers/training/workflow/signing.md)** - GPG and DCO commit signing (required)
68+
- **[Changelog Guide](docs/sdk_developers/training/workflow/changelog_entry.md)** - How to write changelog entries
6969
- **[Rebasing Guide](docs/sdk_developers/rebasing.md)** - Keep your branch up-to-date
70-
- **[Merge Conflicts Guide](docs/sdk_developers/merge_conflicts.md)** - Resolve conflicts
70+
- **[Merge Conflicts Guide](docs/sdk_developers/training/workflow/merge_conflicts.md)** - Resolve conflicts
7171
- **[Typing Guide](docs/sdk_developers/types.md)** - Python type hints
7272
- **[Linting Guide](docs/sdk_developers/linting.md)** - Code quality tools
7373

docs/maintainers/good_first_issue_candidate_guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,6 @@ A candidate should be promoted to a full **Good First Issue** when:
194194

195195
- [Good First Issue Guidelines](./good_first_issues_guidelines.md) — what qualifies as a GFI
196196
- [Contributing Guide](../../CONTRIBUTING.md) — how to contribute
197-
- [DCO Signing Guide](../sdk_developers/signing.md) — commit signing requirements
197+
- [DCO Signing Guide](../sdk_developers/training/workflow/signing.md) — commit signing requirements
198198
- [Discord Community](../discord.md) — get help from the community
199199
- [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meetings/hiero?view=week) — weekly office hours

docs/maintainers/good_first_issues_guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ When evaluating whether to label an issue as a Good First Issue, consider:
243243
## Additional Resources
244244

245245
- [Contributing Guide](../../CONTRIBUTING.md)
246-
- [DCO Signing Guide](../sdk_developers/signing.md)
247-
- [Changelog Entry Guide](../sdk_developers/changelog_entry.md)
246+
- [DCO Signing Guide](../sdk_developers/workflow/training/signing.md)
247+
- [Changelog Entry Guide](../sdk_developers/workflow/training/changelog_entry.md)
248248
- [Discord Community](../discord.md)
249249
- [Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meetings/hiero?view=week)

0 commit comments

Comments
 (0)