Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 2.86 KB

Contributing

We are excited to have you contribute to the aa-sdk. Here's a step-by-step guide to help you get started.

Getting started

  1. Fork and Clone: First, fork the aa-sdk repository. Then, clone your forked repo to your local machine.

  2. Set Up Environment Variables: Create .env file in the root directory using the template .env.example and fill in the values with your Alchemy API key and Paymaster Policy ID where indicated.

  3. Install Dependencies: Ensure you have yarn installed (we use version 1.x). Installation instructions are available here. Run yarn in the project root to install all necessary dependencies.

  4. Testing Environment: Before making changes, make sure to verify the testing environment.

    • Use the Node version specified in package.json (currently 18.16.0). Run node -v to check your version.
    • Build the project with yarn build.
    • Run existing tests using yarn test & yarn test:typecheck to ensure everything is working correctly.

  5. Make Changes: Now, you can start making changes to the packages or docs. When updating or adding new functionality, update or add a new doc in site/packages/* corresponding to the package you have worked on to document the changes.

  6. Re-verify Tests: After making your changes, re-run yarn test & yarn test:typecheck to ensure all tests still pass.

  7. Code Formatting:

    • Format your code changes with yarn run lint:write.
    • Confirm that your code passes format checks with yarn run lint:check.

  8. Docs Changes:

    • To run docs locally: yarn docs:dev.
    • To build SDK docs: yarn docs:sdk.
    • When editing or adding new docs, make sure you follow the docs contributing guidelines

  9. Committing Changes: Commit your changes using a standardized message format.

    • Format: [subject-type]: [description starting with lowercase letters] (#[issue number]).
    • For breaking changes, clearly reflect in your commit message (e.g., feat!: breaking change).
    • Example: feat: add sanity check on provider connect for clearer error message (#181).
    • Example: docs: add new section on gasless transactions (#189).
    • Use git log to see more examples and acceptable subject-types.
    • For more details on semantic PR titles, refer to Flank's guide on PR titles.

  10. Creating a Pull Request:

  • Push your changes to your GitHub fork.
  • Create a pull request against the original aa-sdk repository's development branch.
  • Ensure the pull request title follows the Enforce PR Title Format: [subject-type]: [description starting with lowercase letters]. You can check this using echo "[YOUR_PR_TITLE_HERE] | yarn commitlint.
  1. Celebrate your contribution!