-
Notifications
You must be signed in to change notification settings - Fork 397
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
chore(doc): reuse commands doc from Milos in Makefile and cmd/README #573
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 💯
I've left a minor comment, otherwise it's good to go
Mmm. Would it not be better to keep these in a single place (ie, cmd/README), rather than having them both in Makefile and cmd/README? Just because I can very easily see this becoming out of sync eventually. Or at least add a line saying |
It's true, but we are going to have a lot of developers glancing at gnolang during phase 2 of Game of Realms. The inconvenience for the maintainer is outbalanced by the clarity for the newcomer. If time for syncing is constant and near 0, we want to maximize clarity for developers which may launch projects on GNO. After Game of Realms, we can edit cmd/README to say to read Makefile for a description of the commands. |
I'd still personally add the note saying to keep the two in sync. Rest LGTM 👍 :) |
Milos wrote good 1line docs about the GNO commands. Maybe it would make sense to have them in the Makefile and in cmd/README.
(This is a 5min PR, I won't claim this one).