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 CONTRIBUTING guide, fix PR template, and clean up README #290

Merged
merged 4 commits into from
Nov 29, 2023

Conversation

SahilAujla
Copy link
Member

@SahilAujla SahilAujla commented Nov 29, 2023

PR-Codex overview

This PR updates the pull request checklist and adds more detailed instructions in the README and CONTRIBUTING.md files.

Detailed summary

  • Updated the pull request checklist in the PULL_REQUEST_TEMPLATE.md file.
  • Added more detailed instructions and information in the README.md file.
  • Updated the CONTRIBUTING.md file with a step-by-step guide for contributors.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link
Contributor

@avasisht23 avasisht23 left a comment

Choose a reason for hiding this comment

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

nits, then good to go

CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated

The SDK also implements an EIP-1193 provider interface to easily plug into any popular dapp or wallet connect libraries such as RainbowKit, Wagmi, and Web3Modal. It also includes ethers.js adapters to provide full support for ethers.js apps.

The `aa-sdk` is modular at every layer of the stack and can be easily extended to fit your custom needs. You can plug in any [smart account](https://accountkit.alchemy.com/smart-accounts/accounts/using-your-own) implementation, [Signer](https://accountkit.alchemy.com/smart-accounts/signers/overview), [Gas Manager API](https://accountkit.alchemy.com/overview/introduction.html#gas-manager-api), RPC provider.
The `aa-sdk` is modular at every layer of the stack and can be easily extended to fit your custom needs. You can plug in any [smart account](https://accountkit.alchemy.com/smart-accounts/accounts/using-your-own) implementation, [Signer](https://accountkit.alchemy.com/smart-accounts/signers/overview), Gas Manager API and RPC Provider.
Copy link
Contributor

Choose a reason for hiding this comment

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

hyperlink to gas manager docs?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!

SahilAujla and others added 3 commits November 28, 2023 22:06
Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>
Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>
@SahilAujla SahilAujla merged commit 4420295 into development Nov 29, 2023
3 checks passed
@SahilAujla SahilAujla deleted the contributing-2 branch November 29, 2023 03:10
@moldy530 moldy530 mentioned this pull request Dec 1, 2023
8 tasks
moldy530 pushed a commit that referenced this pull request Dec 1, 2023
…#290)

* docs: update CONTRIBUTING guide, fix PR template, and clean up README

* Update CONTRIBUTING.md

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

* Update README.md

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

* docs: make requested changes

---------

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>
moldy530 pushed a commit that referenced this pull request Dec 1, 2023
…#290)

* docs: update CONTRIBUTING guide, fix PR template, and clean up README

* Update CONTRIBUTING.md

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

* Update README.md

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

* docs: make requested changes

---------

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>
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.

2 participants