Skip to content

Commit a00fcee

Browse files
authored
docs: Improve contributing section in README (#522)
Signed-off-by: Pranay <[email protected]>
1 parent 920c898 commit a00fcee

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
1818
- Refactored `examples/transfer_hbar.py` to improve modularity by separating transfer and balance query operations into dedicated functions
1919
- Enhanced contributing section in README.md with resource links
2020
- Refactored examples/topic_message_submit.py to be more modular
21+
- docs: Improved the contributing section in the README.md file
2122

2223
### Fixed
2324
- Added explicit read and write permissions to test.yml

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,18 @@ Topic deletion successful.
154154

155155
## Contributing
156156

157-
We appreciate your interest in improving the Hiero Python SDK! Please see [CONTRIBUTING.md](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/CONTRIBUTING.md) for details about our contribution process, including bug reports, feature requests, and code contributions.
157+
We appreciate your interest in improving the Hiero Python SDK!
158+
Interested in helping out? We'd love for you to contribute!
159+
160+
Before you start, it's **essential** that you carefully read our main contribution guide: **[CONTRIBUTING.md](./CONTRIBUTING.md)**. This document is your roadmap to making a successful contribution.
161+
162+
Following the steps in this guide is the best way to ensure your pull request (PR) can be merged smoothly. It covers crucial requirements, including:
163+
164+
* How to get your commits **verified** (which is mandatory for merging).
165+
* The correct way to update the **changelog** with your changes.
166+
* The full step-by-step workflow for submitting code.
167+
168+
Our guide also explains how you can contribute in other ways, like submitting **bug reports** and proposing new **feature requests**.
158169

159170
### Links
160171
- [Hiero Python SDK Discord](https://discord.com/channels/905194001349627914/1336494517544681563)

0 commit comments

Comments
 (0)