Skip to content

chore: Add setup instructions for running example scripts #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ruhi14
Copy link

@Ruhi14 Ruhi14 commented Jul 17, 2025

Description:

Add setup instructions to help new users run example scripts from the /examples folder.

Created a new README_examples.md inside the examples/ directory to guide users on:

  • Setting up environment variables via .env
  • Getting Hedera Testnet credentials
  • Running example scripts with python3

Related issue(s):

Fixes #169

Notes for reviewer:

The original README.md is now restored to match main.
All example setup instructions are moved to a dedicated file for clarity and maintainability.

Checklist:

  • Documented (new README_examples.md)
  • Tested (instructions verified locally)

@exploreriii
Copy link
Contributor

exploreriii commented Jul 17, 2025

Hi @Ruhi14 thank you for having a go at this.
There's a lot of good content here that will make it easier for new starters - thank you.

You have added new content to the README (the instruction running example scripts section), but you have also changed the existing sections in the README. You can see this by looking here https://github.com/hiero-ledger/hiero-sdk-python/pull/195/files with the red indicating content deleted and green content added.

1)May I suggest either creating a separate instructions.md or README_examples.md inside the hedera_sdk_python/examples OR restoring the original version of the README.md, keeping most content untouched, and just adding the new section.

2)We also require your commits to be signed, we have a guide Commit_Signing.md.

  1. The title of your pull request should read:
    chore: Add setup instructions for running example scripts
    (change that by clicking the edit button on the top right of this page)

Given both 1) and 2) it might be easiest to create a fresh branch from main, copy in your desired section to README.md or as a new file in /examples. Then ensure you sign with: git commit -S -s -m "chore: your commit message". But there are several valid ways to do it. Let us know if you need help.
Thanks again

Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going good!...next steps suggested

@Ruhi14
Copy link
Author

Ruhi14 commented Jul 20, 2025

hi @exploreriii Thank you so much for your helpful feedback and for highlighting the areas to improve.

I apologize for making broader changes to the README than intended. To address your suggestions:

I’ll either restore the original README.md and add the new section as a separate file under /examples, or update only the new section in README.md, as recommended.

I’ll ensure my commits are properly signed, following the Commit_Signing.md guide.

I’ll update the PR title to: chore: Add setup instructions for running example scripts.

Thank you for the clear instructions! I’ll make these changes soon. Please let me know if you have any further guidance.

@Ruhi14 Ruhi14 changed the title Add setup instructions for running example scripts (#169) chore: Add setup instructions for running example scripts Jul 20, 2025
@exploreriii
Copy link
Contributor

Excellent, looking forward. If you come across any technical questions, you can reply here or also in our discord https://discord.gg/hyperledger
-> python

@nadineloepfe
Copy link
Contributor

nadineloepfe commented Jul 22, 2025

Hi @Ruhi14
Thank you so much for your contribution!

To add to @exploreriii's comment:
Formatting is quite important in a README for readability. For codeblocks, we use ``` before and after the specified section. For headings, # is used (# for the main heading, ## for smaller headings, ### for even smaller ones).
If you're using VS code, you can use the preview function to see how it will look like on Github.

Let me know if you have any questions!

@exploreriii
Copy link
Contributor

Oh yes! The file is README.md, so it uses markdown. When you hit 'preview' or you view on a url will look much more human friendly. For more basic syntax:
https://www.markdownguide.org/cheat-sheet/
If you are using VS code you can preview how the markdown looks by clicking press Ctrl+Shift+V or there is a preview button

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Good First Issue: Expand README in /examples
3 participants