For this week’s Hacktoberfest contribution, I worked on improving documentation for the Hiero SDK Python project. The repository provides a set of tools and abstractions for handling tokens and custom fees in the Hiero network.
I found an open issue titled "Add module, class, and method docstrings to custom_fee.py". The maintainers wanted comprehensive Google-style docstrings for the CustomFee abstract base class and its methods. The goal was to improve readability, contributor understanding, and maintainability.
I had to first ask if I can contribute to the project and await approval before proceeding. I forked and cloned the repository from Github and created a new branch called issue-680-docstrings-customfee. I later on added a module level docstring describing the purpose of the file and completed the issue requirements. I then committed and pushed the changes to my fork and opened a pull request to the main repository.
This issue helped me practice writing Google-style docstrings consistently, understand how abstract base classes work in Python and enhance my skills in GitHub contributing to another open source repository. I appreciated how clear documentation improves project accessibility for new contributors.
Overall, this was a smooth one. I had to search on how to add a GPG key on GitHub as I did not have one and this was a requirement in the owners contributing.md file as well as DCO signing. I understood this was to ensure professional collaboration and I liked it a sit was my first time ending up with signed commits.
Top comments (0)