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.

Sign up for GitHub

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

Jump to bottom

Add READMEs in all major directories #2

Closed
RmbRT opened this issue Apr 14, 2022 · 4 comments
Closed

Add READMEs in all major directories #2

RmbRT opened this issue Apr 14, 2022 · 4 comments
Assignees
@leandro-ro

Comments

@RmbRT
Copy link

RmbRT commented Apr 14, 2022

1-sentence descriptions of the packages should suffice for now.
@RmbRT
Copy link
Author

RmbRT commented Apr 14, 2022

@leandro-ro

@matthiasgeihs
Copy link
Contributor

Adding READMEs to all directories sounds a little bit overkill to me. For documenting go packages the go doc should be sufficient and preferred.

@RmbRT
Copy link
Author

RmbRT commented Apr 14, 2022

It was just pretty hard to navigate the project during the meeting today, and it would help to be able to see what does what when browsing the repo. Those readmes can be deleted again later.

@matthiasgeihs
Copy link
Contributor

In this case I suggest you document that in a separate document.

@leandro-ro leandro-ro closed this as not planned Won't fix, can't repro, duplicate, stale Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leandro-ro leandro-ro

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@RmbRT @leandro-ro @matthiasgeihs