Skip to content

Commit 993ccfe

Browse files
committed
chore: increased flow and clarity in contributing section
Signed-off-by: exploreriii <[email protected]>
1 parent b97935d commit 993ccfe

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,30 @@ Thank you for your interest in contributing to the Hiero Python SDK!
2020

2121
### 💻 Code Contributions
2222

23-
**Get started:** See [Setup Guide](docs/sdk_developers/setup.md)
23+
**Get Started By Reading:**
24+
25+
- [Project Structure](docs/sdk_developers/project_structure.md)
26+
- [Setup](docs/sdk_developers/training/setup)
27+
- [Workflow](docs/sdk_developers/training/workflow)
28+
29+
**Quick Start:**
2430

25-
**Quick workflow:**
2631
1. Find/create an issue → [Issues](https://github.com/hiero-ledger/hiero-sdk-python/issues)
2732
2. Get assigned (comment "I'd like to work on this")
28-
3. Follow the [Workflow Guide](docs/sdk_developers/workflow.md)
29-
4. Submit a PR
30-
31-
**Requirements:**
32-
- Signed commits (GPG + DCO) - [Signing Guide](docs/sdk_developers/signing.md)
33-
- Updated changelog - [Changelog Guide](docs/sdk_developers/changelog_entry.md)
34-
- Tests pass
35-
- Code quality checks - [Checklist](docs/sdk_developers/checklist.md)
33+
3. Follow [Setup Guide](docs/sdk_developers/training/setup)
34+
3. Follow [Workflow Guide](docs/sdk_developers/workflow.md)
35+
4. GPG and DCO sign commits [Quickstart Signing](docs/sdk_developers/training/workflow/07_signing_requirements.md)
36+
5. Add a Changelog Entry [Quickstart Changelog](docs/sdk_developers/training/workflow/09_changelog_entry.md)
37+
4. Submit a PR [Quickstart Submit PR](docs/sdk_developers/training/workflow/11_submit_pull_request.md)
38+
39+
**Detailed Docs:**
40+
41+
- [Setup Guide](docs/sdk_developers/setup.md)
42+
- [Signing Guide](docs/sdk_developers/signing.md)
43+
- [Changelog Guide](docs/sdk_developers/changelog_entry.md)
44+
- [Rebasing Guide](docs/sdk_developers/rebasing.md)
45+
- [Merge Conflicts Guide](docs/sdk_developers/merge_conflicts.md)
46+
- [Testing Guide](docs/sdk_developers/testing.md)
3647

3748

3849
#### ⚠️ A Note on Breaking Changes

0 commit comments

Comments
 (0)