Skip to content
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

Updates to README and CONTRIBUTING guide #29

Merged
merged 3 commits into from
May 9, 2024
Merged

Conversation

drohit-cb
Copy link
Contributor

Description Of Change

This PR helps:

  1. Fix link to official repo within contributing guide
  2. Update README to fix some quotes in ts example code and update some verbiage
  3. Move contribution section above documentation in README

Testing Procedure

Manually reviewed the README on Github.

@drohit-cb drohit-cb marked this pull request as ready for review May 9, 2024 18:50
@drohit-cb drohit-cb requested review from ProfMoo and marcin-cb May 9, 2024 18:54
Copy link
Contributor

@ProfMoo ProfMoo left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -39,10 +39,9 @@ Prerequisite: [Node 20+](https://www.npmjs.com/package/node/v/20.11.1)

### Stake Partial ETH :diamond_shape_with_a_dot_inside:

This code sample creates an ETH staking workflow. View the full code sample [here](examples/ethereum/create-workflow.ts)
This code sample helps stake partial ETH (non-multiples of 32 ETH). View the full source [here](examples/ethereum/create-workflow.ts)

Choose a reason for hiding this comment

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

Suggested change
This code sample helps stake partial ETH (non-multiples of 32 ETH). View the full source [here](examples/ethereum/create-workflow.ts)
This code sample helps stake ETH via partial staking. View the full source [here](examples/ethereum/create-workflow.ts)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ooops - merged and later saw this. Can incorporate in next PRs.

@drohit-cb drohit-cb merged commit 10c00cb into main May 9, 2024
3 checks passed
@drohit-cb drohit-cb deleted the updates_after_bug_bash branch May 9, 2024 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants