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

chore!: added documentation for root level and signer module #32

Merged
merged 10 commits into from
Dec 19, 2024

Conversation

akorchyn
Copy link
Collaborator

@akorchyn akorchyn commented Dec 18, 2024

Also, changed API of the Signer to work with a seed phrase as &str instead of String
Improved naming convention
@race-of-sloths

@akorchyn akorchyn changed the title chore: added documentation for root level and signer module chore!: added documentation for root level and signer module Dec 18, 2024
@race-of-sloths
Copy link

race-of-sloths commented Dec 18, 2024

@akorchyn Thank you for your contribution! Your pull request is now a part of the Race of Sloths!

Shows inviting banner with latest news.

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@PolyProgrammist 5

Your contribution is much appreciated with a final score of 5!
You have received 55 (50 base + 10% lifetime bonus) Sloth points for this contribution

@PolyProgrammist received 25 Sloth Points for reviewing and scoring this pull request.

We would appreciate your feedback or contribution idea that you can submit here

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

  • Tag @race-of-sloths inside your pull requests
  • Wait for the maintainer to review and score your pull request
  • Check out your position in the Leaderboard
  • Keep weekly and monthly streaks to reach higher positions
  • Boast your contributions with a dynamic picture of your Profile

For maintainers:

  • Score pull requests that participate in the Race of Sloths and receive a reward
  • Engage contributors with fair scoring and fast responses so they keep their streaks
  • Promote the Race to the point where the Race starts promoting you
  • Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands
  • For contributors
    • Include a PR: @race-of-sloths include to enter the Race with your PR
  • For maintainers:
    • Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
    • Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
    • Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
    • Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

Copy link
Collaborator

@PolyProgrammist PolyProgrammist left a comment

Choose a reason for hiding this comment

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

Hi! Left some comments. Overall, looks great

src/signer/mod.rs Outdated Show resolved Hide resolved
src/signer/mod.rs Show resolved Hide resolved
examples/sign_options.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/signer/mod.rs Show resolved Hide resolved
src/signer/mod.rs Outdated Show resolved Hide resolved
src/signer/mod.rs Show resolved Hide resolved
src/signer/mod.rs Show resolved Hide resolved
src/signer/mod.rs Outdated Show resolved Hide resolved
@PolyProgrammist
Copy link
Collaborator

Please check these 2 comments.
#32 (comment)
#32 (comment)

Overall, already looks good to me.

About the docs, maybe if you can add any references to docs.near.org, that's good. But anyway, not that important, can be done later

@akorchyn
Copy link
Collaborator Author

@PolyProgrammist I have added some more info to look at near_ledger impl.
Also, I linked FT, NEAR, and NFT to docs.near.org. But I would probably add more links in separate PR.

@akorchyn akorchyn enabled auto-merge (squash) December 19, 2024 22:44
@akorchyn akorchyn merged commit ad90118 into main Dec 19, 2024
7 checks passed
@akorchyn akorchyn deleted the doc-first branch December 19, 2024 22:51
@race-of-sloths
Copy link

🥁 Score it!

@akorchyn, please ask your peers to score the PR using @race-of-sloths score [1/2/3/5/8/13].
If no scoring is provided within 24 hours, this PR will be scored as 2 🦥

@frol frol mentioned this pull request Dec 18, 2024
@akorchyn akorchyn linked an issue Dec 19, 2024 that may be closed by this pull request
@PolyProgrammist
Copy link
Collaborator

@race-of-sloths score 6

@race-of-sloths
Copy link

🏆 Score recorded!

It looks like @PolyProgrammist provided a score of 6, but based on our Fibonacci scoring rules, we've adjusted it to 5.

Tip

We accept only the following Fibonacci numbers [0, 1, 2, 3, 5, 8, 13] for scoring

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.

Documentation
3 participants