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

docs: update RPC error schema update process #1364

Merged
merged 2 commits into from
Aug 5, 2024

Conversation

jakmeier
Copy link
Contributor

This commit updates the README description for how to update to a new RPC error schema.

I also delete two files in near-api-js which seem to be unused. The source of truth, as far as I can tell, is in the utils package now.

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • Commit messages follow the conventional commits spec
  • If this is a code change: I have written unit tests.
  • If this changes code in a published package: I have run pnpm changeset to create a changeset JSON document appropriate for this change.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

I got confused as to how to update the generated files since the README is outdated and it's unclear how to update these files. But since I couldn't find out where they are used, the code only references the files in the utils package. I assume the other files are left over from previous code structures and should rather be deleted to clean things up.

Test Plan

Related issues/PRs

Related: #1358

This commit updates the README description for how to
update to a new RPC error schema.

I also delete two files in near-api-js which seem to be unused.
The source of truth, as far as I can tell, is in the utils package now.
Copy link

changeset-bot bot commented Jul 22, 2024

⚠️ No Changeset found

Latest commit: 8e45a02

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jakmeier jakmeier requested a review from gtsonevv July 22, 2024 11:08
@jakmeier
Copy link
Contributor Author

@race-of-sloths please, include my PR in the race

@race-of-sloths
Copy link

race-of-sloths commented Jul 25, 2024

@jakmeier Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
New Sloth joined the Race! Welcome!

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@andy-haynes 2

Your contribution is much appreciated with a final score of 2!
You have received 30 (20 base + 10 weekly bonus) Sloth points for this contribution

Another weekly streak completed, well done @jakmeier! To keep your weekly streak and get another bonus make pull request next week! Looking forward to see you in race-of-sloths

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
  • 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:
    • 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

@jakmeier jakmeier requested review from andy-haynes and removed request for gtsonevv July 30, 2024 16:40
@andy-haynes
Copy link
Collaborator

@race-of-sloths score 2

@andy-haynes andy-haynes merged commit 9d86917 into near:master Aug 5, 2024
1 check passed
@jakmeier jakmeier deleted the update-error-schema-docs branch August 7, 2024 16:50
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.

3 participants