-
Notifications
You must be signed in to change notification settings - Fork 24
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
base: main
Are you sure you want to change the base?
Conversation
Hi @Ruhi14 thank you for having a go at this. 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.
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. |
There was a problem hiding this 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
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. |
Excellent, looking forward. If you come across any technical questions, you can reply here or also in our discord https://discord.gg/hyperledger |
Hi @Ruhi14 To add to @exploreriii's comment: Let me know if you have any questions! |
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: |
Description:
Add setup instructions to help new users run example scripts from the
/examples
folder.Created a new
README_examples.md
inside theexamples/
directory to guide users on:.env
python3
Related issue(s):
Fixes #169
Notes for reviewer:
The original
README.md
is now restored to matchmain
.All example setup instructions are moved to a dedicated file for clarity and maintainability.
Checklist:
README_examples.md
)