Improve readme: Add Preperation section

safe-global / safe-core-sdk

The Safe{Core} SDK allows builders to add account abstraction functionality into their apps.

https://docs.safe.global/sdk/overview

MIT License

243 stars 178 forks source link

Improve readme: Add Preperation section #785

Closed Citrullin closed 1 month ago

Citrullin commented 2 months ago

What it solves

When a user freshly clones the repository and builds/tests one specific package, it will fail due to missing types.

How this PR fixes it

Just adds a little section in the readme that notifies the reader over this behaviour.

github-actions[bot] commented 2 months ago

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the CLA Document and I hereby sign the CLA

_{You can retrigger this bot by commenting recheck in this Pull Request}

dasanra commented 1 month ago

@Citrullin thank you for your suggestion. We will be covering this topic adding a CONTRIBUTING file explaining a bit better how to use this repository. We would still keep on top the instructions for those wanting to use the different packages.