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

doc: improved documentation for near-sdk and near-sdk-macros crates #1262

Merged
merged 36 commits into from
Jan 30, 2025

Conversation

PolyProgrammist
Copy link
Collaborator

@PolyProgrammist PolyProgrammist commented Nov 20, 2024

Resolves: #1294

  • Improved documentation for near-sdk crate (adding more link, actualize documentation, extending examples)
  • Added documentation for near-sdk-macros crate (near, near_bindgen, etc)
  • Actualize Readme.md file

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.26%. Comparing base (0027201) to head (3115a09).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1262      +/-   ##
==========================================
+ Coverage   80.24%   80.26%   +0.01%     
==========================================
  Files         104      104              
  Lines       14819    14819              
==========================================
+ Hits        11892    11894       +2     
+ Misses       2927     2925       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -500,6 +500,8 @@ pub fn alt_bn128_pairing_check(value: &[u8]) -> bool {
// ################
/// Creates a promise that will execute a method on account with given arguments and attaches
/// the given amount and gas.
Copy link
Collaborator

Choose a reason for hiding this comment

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

@PolyProgrammist suggest adding more links, mentioned in #1265 and marked up in review of #1259,
in addition to ones, added in scope of current pr, after fixing conflicts, if you plan to finish current pr

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Which links do you mean? @dj8yfo

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added half of the comments. Left the other for the future

Copy link
Contributor

@denbite denbite left a comment

Choose a reason for hiding this comment

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

Great job on this, I've dropped a few comments with some thoughts on how it could be even better
it's mainly focused on adding more examples

@PolyProgrammist PolyProgrammist marked this pull request as ready for review December 20, 2024 17:15
@PolyProgrammist
Copy link
Collaborator Author

@dj8yfo @denbite thanks for the review. Please check again

Copy link
Collaborator

@akorchyn akorchyn left a comment

Choose a reason for hiding this comment

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

Overall good job. However, I added a couple nits and one major point to fix (use the near macro in root macro)

@akorchyn akorchyn changed the title Impr docs doc: improved documentation for near-sdk and near-sdk-macros crates Jan 30, 2025
@akorchyn
Copy link
Collaborator

@race-of-sloths score 13

@race-of-sloths
Copy link

race-of-sloths commented Jan 30, 2025

@PolyProgrammist Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Do you want to apply for monthly streak? Get 8+ score for a single PR this month and receive boost for race-of-sloths!

Shows inviting banner with latest news.

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@akorchyn 13

Your contribution is much appreciated with a final score of 13!
You have received 150 (130 base + 10 weekly bonus + 10 monthly bonus) Sloth points for this contribution

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

Congratulations @PolyProgrammist! Your PR was highly scored and you completed another monthly streak! To keep your monthly streak make another pull request next month and get 8+ score for it

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

@akorchyn akorchyn self-requested a review January 30, 2025 14:24
@akorchyn akorchyn merged commit 25414c6 into near:master Jan 30, 2025
39 checks passed
This was referenced Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Shipped 🚀
Development

Successfully merging this pull request may close these issues.

add template repo link in readme
5 participants