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 Utilities/README.md #30

Open
DuaneOBrien opened this issue Oct 29, 2020 · 2 comments
Open

Add Utilities/README.md #30

DuaneOBrien opened this issue Oct 29, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest unclaimed

Comments

@DuaneOBrien
Copy link
Contributor

The scripts in the Utilities directory are currently undocumented. We should add a readme to the Utilities directory that describes each utility and how it works.

To be accepted, a pull request that fixes this issue must:

  • Add a readme file to the Utilities directory
  • Describe the use and usage of each script in the Utilities directory using a common format
  • Update the root project README.md to link to add a short section describing the utilities are available, linking to the new Utilities/README.md file for more information.
@DuaneOBrien DuaneOBrien added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest unclaimed labels Oct 29, 2020
@redgardner
Copy link

Okay if I take a stab at this one?

@DuaneOBrien
Copy link
Contributor Author

@redgardner sorry for the delay on this one, but feel free if you'd like to push an update!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest unclaimed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@DuaneOBrien @redgardner