Contract Headers #49
threepwave
started this conversation in
Ideas
Replies: 1 comment 1 reply
-
This is A+ Perhaps we have a standard for indicating what other modules that module has write access to? |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I ran through all of the
settling_game
contracts and added a standard header.I tried to keep it lightweight and simple so it wouldn't require a ton of overhead. Just a quick synopsis for those new to the repo or who haven't touched a file in a while.
The format I started with is:
In practice this looks like (e.g. imodules.cairo):
Would love any and all feedback here!
I also started an issue with a set of contracts that I didn't feel knowledgeable enough to write the title / description for so would appreciate if people can pick off contracts they're familiar with in the
docs/header
branch.Beta Was this translation helpful? Give feedback.
All reactions