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: moved near-sdk-macros doc to near-sdk crate. #1295

Merged
merged 10 commits into from
Feb 4, 2025
Merged

Conversation

akorchyn
Copy link
Collaborator

Resolves: #1288

  • Replaced ignore -> rust for examples to be able to test them in CI

…rust for examples to be able to test them in CI
@akorchyn
Copy link
Collaborator Author

@race-of-sloths

@race-of-sloths
Copy link

race-of-sloths commented Jan 30, 2025

@akorchyn Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Congratulatory messages are spent out! Your results have exceeded our imagination!

Shows inviting banner with latest news.

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@dj8yfo 8

Your contribution is much appreciated with a final score of 8!
You have received 160 (80 base + 25 weekly bonus + 40 monthly bonus + 10% lifetime bonus) Sloth points for this contribution

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

Congratulations @akorchyn! 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

Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.23%. Comparing base (cc22bb2) to head (70a2e6b).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1295   +/-   ##
=======================================
  Coverage   80.23%   80.23%           
=======================================
  Files         104      104           
  Lines       14819    14819           
=======================================
  Hits        11890    11890           
  Misses       2929     2929           

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

near-sdk/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Collaborator

@dj8yfo dj8yfo left a comment

Choose a reason for hiding this comment

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

@race-of-sloths score 8

### Tasks
- [x] near_sdk_macros::ext_contract
- [x] near_sdk_macros::near
- [x] near_sdk_macros::near_bindgen
- [x] near_sdk_macros::BorshStorageKey
- [x] near_sdk_macros::EventMetadata
- [x] near_sdk_macros::FunctionError
- [x] near_sdk_macros::NearSchema
- [x] near_sdk_macros::PanicOnDefault
- [ ] add BIG BIG HIGHLIGHTED link from QuickStart section, leading to `#[near]` documentation

near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Show resolved Hide resolved
near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Show resolved Hide resolved
near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Outdated Show resolved Hide resolved
near-sdk/src/lib.rs Show resolved Hide resolved
/// pub name: String,
/// }
/// ```
pub use near_sdk_macros::near_bindgen;
Copy link
Collaborator

Choose a reason for hiding this comment

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

near_bindgen can be cut and pasted just after near, because they're both twin brothers, one handsome, another - an ugly one

near-sdk/src/lib.rs Outdated Show resolved Hide resolved
@dj8yfo
Copy link
Collaborator

dj8yfo commented Feb 3, 2025

@akorchyn could you also grab the deletion of this fragment from README as part of this pr?
I don't think it's too relevant now and it just increases README size.
image

@akorchyn akorchyn enabled auto-merge (squash) February 4, 2025 10:09
@akorchyn akorchyn merged commit 0a805b5 into master Feb 4, 2025
37 checks passed
@akorchyn akorchyn deleted the documentation-move branch February 4, 2025 10:46
@frol frol mentioned this pull request Feb 3, 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 🚀
3 participants