Skip to content
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

Merged
merged 5 commits into from
Mar 9, 2023

Conversation

grepsuzette
Copy link
Contributor

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).

@grepsuzette grepsuzette requested a review from a team as a code owner March 8, 2023 06:49
@moul moul requested a review from zivkovicmilos March 8, 2023 07:13
Copy link
Member

@zivkovicmilos zivkovicmilos left a 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

@thehowl
Copy link
Member

thehowl commented Mar 8, 2023

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 NOTE: keep in sync with Makefile and viceversa.

@grepsuzette
Copy link
Contributor Author

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 NOTE: keep in sync with Makefile and viceversa.

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.

@thehowl
Copy link
Member

thehowl commented Mar 8, 2023

I'd still personally add the note saying to keep the two in sync.

Rest LGTM 👍 :)

Co-authored-by: Morgan <git@howl.moe>
@moul moul merged commit 469b97a into gnolang:master Mar 9, 2023
@grepsuzette grepsuzette deleted the doc-commands branch March 13, 2023 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

4 participants