You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Move any top level documentation about the solidity contracts to contracts/README.md and link to them from the root readme file.
It should be easy for someone who doesn't know the setup to go in and get a good overview over how the system works and how the different contracts interact.
Make sure the new README has at least the following:
Hi @HMSagar2701, thanks for the interest, but I was thinking maybe the team should take this one on as it requires quite deep understanding of all the components. If you anyway feel like you would be able to deep dive into how it works and do this, I will not stop you from making a PR which I will happily review :)
Move any top level documentation about the solidity contracts to
contracts/README.md
and link to them from the root readme file.It should be easy for someone who doesn't know the setup to go in and get a good overview over how the system works and how the different contracts interact.
Make sure the new README has at least the following:
The text was updated successfully, but these errors were encountered: