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

scripts in /utils missing documentation #1228

Closed
sbts opened this issue Jan 8, 2016 · 1 comment
Closed

scripts in /utils missing documentation #1228

sbts opened this issue Jan 8, 2016 · 1 comment
Labels
bite-sized Deemed a good starting point for new contributors to learn about the code base. type:enhancement Proposed improvement, new feature, or extension -- not a defect

Comments

@sbts
Copy link
Member

sbts commented Jan 8, 2016

We need to document all scripts and other files in /tools and /utils

The suggestion is to follow roughly this....
* All executables must use a command line option --help that displays a Usage Summary followed by more detail if required.

* All executables must use a command line option --readme that displays a markdown formatted chunck containing script description an usage summary

* All executables must use a command line option --version that reports the script version in "scriptname v1.0.0" format

There is a mailing list discussion about this, I'll add a link later.
@sbts sbts added the bite-sized Deemed a good starting point for new contributors to learn about the code base. label Jan 8, 2016
@sbts sbts self-assigned this Jan 8, 2016
@sbts sbts added this to the 1.5 milestone Jan 8, 2016
@ehuelsmann ehuelsmann added the type:enhancement Proposed improvement, new feature, or extension -- not a defect label Jun 5, 2016
@ehuelsmann ehuelsmann added bite-sized Deemed a good starting point for new contributors to learn about the code base. type:enhancement Proposed improvement, new feature, or extension -- not a defect and removed bite-sized Deemed a good starting point for new contributors to learn about the code base. type:enhancement Proposed improvement, new feature, or extension -- not a defect Minor enhancement labels Dec 17, 2017
@ehuelsmann ehuelsmann modified the milestones: 1.5, 1.6 Mar 3, 2018
@ehuelsmann ehuelsmann modified the milestones: 1.6, 1.7 May 10, 2018
@ehuelsmann ehuelsmann modified the milestones: 1.7, 1.8 Jun 23, 2019
@ehuelsmann ehuelsmann changed the title scripts in /utils and /tools missing documentation scripts in /utils missing documentation Jan 5, 2020
@ehuelsmann ehuelsmann removed this from the 1.8 milestone Jan 5, 2020
@ehuelsmann
Copy link
Member

The scripts which are relevant for users have been moved to /bin. All scripts in /utils should be relevant strictly to developers (or are remnants which haven't been tested for a long time -- meaning I didn't feel comfortable moving them to /bin).

@snyk-bot snyk-bot mentioned this issue Nov 18, 2020
Open
@snyk-bot snyk-bot mentioned this issue Sep 16, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bite-sized Deemed a good starting point for new contributors to learn about the code base. type:enhancement Proposed improvement, new feature, or extension -- not a defect
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@einhverfr @ehuelsmann @sbts