Skip to content

add AppSpec docs #51

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

Open
MichaelDimmitt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add AppSpec docs #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions bash/AppSpec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

30 changes: 30 additions & 0 deletions elixir/AppSpec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.