From 52034f2c2ba17fd56160a89b64d32e1989a841fe Mon Sep 17 00:00:00 2001 From: michael Date: Wed, 27 Sep 2023 13:11:10 -0400 Subject: [PATCH] add AppSpec docs --- bash/AppSpec.md | 30 ++++++++++++++++++++++++++++++ elixir/AppSpec.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 bash/AppSpec.md create mode 100644 elixir/AppSpec.md diff --git a/bash/AppSpec.md b/bash/AppSpec.md new file mode 100644 index 0000000..f58cfe7 --- /dev/null +++ b/bash/AppSpec.md @@ -0,0 +1,30 @@ +## Functionality Checklist for each language + +After updating this document please modify the checklist here: +https://github.com/murjax/Github-Repo-Cloner/issues/44 + +#### Input +- [ ] accept `user/org name` as a command line argument. +- [ ] prompt for input if no `user/org name` supplied +#### Core functionality +- [ ] contact GitHub api to list repos for page 1. +- [ ] paginate GitHub api requests to get all repos. +- [ ] clones all of the repos. +- [ ] put repos into a folder with name `user/org`. +#### Error handling +- [ ] api request limit exceeded +- [ ] `user/org` does not exist. +- [ ] are you connected to the internet? +#### Stretch +- [ ] accept multiple usernames as a command line arguments +- [ ] ci/cd check to see if updating +- [ ] tests for ci/cd check + +## Common Use-cases: +1. Updating all of an organization projects. +- fix readmes +- check dead links +- more things related to 1 ... coming soon. + +2. Consolidate readme projects. + diff --git a/elixir/AppSpec.md b/elixir/AppSpec.md new file mode 100644 index 0000000..f58cfe7 --- /dev/null +++ b/elixir/AppSpec.md @@ -0,0 +1,30 @@ +## Functionality Checklist for each language + +After updating this document please modify the checklist here: +https://github.com/murjax/Github-Repo-Cloner/issues/44 + +#### Input +- [ ] accept `user/org name` as a command line argument. +- [ ] prompt for input if no `user/org name` supplied +#### Core functionality +- [ ] contact GitHub api to list repos for page 1. +- [ ] paginate GitHub api requests to get all repos. +- [ ] clones all of the repos. +- [ ] put repos into a folder with name `user/org`. +#### Error handling +- [ ] api request limit exceeded +- [ ] `user/org` does not exist. +- [ ] are you connected to the internet? +#### Stretch +- [ ] accept multiple usernames as a command line arguments +- [ ] ci/cd check to see if updating +- [ ] tests for ci/cd check + +## Common Use-cases: +1. Updating all of an organization projects. +- fix readmes +- check dead links +- more things related to 1 ... coming soon. + +2. Consolidate readme projects. +