DEFINE: Inspect and Refine GitHub API: Scope, Constraints and Assumptions for the groundwork on Epics, Features, and User Stories

[iPoetDev]

[DEFINE](): Inspect, Refine and Define GitHub API as a Candidate Datasource for Dash & Do GitHub.

PROJECT | SOLUTION: Concept | Idea Capture | Discovery

• Ideation, Concept
• Research
• Readme
  • Writing
  • Diagramming
• Proofing
• Editorial

Idea

Use GitHub API to define and scope the core and critical DataSource 
For Dash and Do GitHub Manager, 
As well as permissible and authorizable actions and limitations from GitHub LLC.

Context and Problem

The GitHub API is massive, 
And has fair to many applications program interfaces 
Than what is needed for the project, 
So this context is to investing time 
- to research, 
- to refine and 
- to define 
a) what is possible, 
b) what is not possible and 
c) what is permissible by GitHub

Theme | Initiative | Epic | Story

Theme

Inspect the GitHub API

Initiative

Define the constraints, scope and capabilities of the GItHub API 
As key data source and dependency 
For this project within 1-2 weeks 
And plan out the user stories and features as an output from this initiative, 

So that we can, as an outcome, decide to
- move forward with our original conception or 
- must redraw a new one 
- based on more information and 
- less based on assumptions

While sticking to the real-world domain of GitHub as the target domain 
For Developer as a the key target audience.`

ADR: Any Decision Records

The following a key design decision and selection options in employing GitHub API at the highest level.

• ADR000X: Select the GitHub API Technology: REST or GraphQL
• ADR000X: Select the SDK method for accessing GitHub API: GitHub CLI, OctoKit Libraries, or 3rd Party Libraries
• ADR000X: Use GitHub API CORS for Ajax Requests

Epic

To Be defined and listed here

Features

To Be defined and listed here

• Has an accessible landing page
• Has an independent Account Registration
• Has an independent Account Login
• Has an independent Password Reset
• Maybe has 2FA authentication (NINTH)
• Has GitHub Account Integration
• Has GitHub Account Social Login

User Use Cases

• User to login to their account using GitHub using a social account integration
• User to integrate their account with one or more GitHub social accounts
• User to disconnect their account with one or more GitHub social accounts
• User disconnected account with one or more GitHub social accounts has their data removed or archived.
• User can list and view all their repositories in one view or in a multi select combo box.

App Use Cases

• The app can programmatically fetch and get/read the correct GitHub API
• The app can programmatically fetch and get a user authorisation token
• The app can programmatically fetch, get, and successfully authorised and access a user account with an user's authorisation token
• The app can programmatically fetch, get, and handle known API errors
• The app can programmatically fetch, get, and handle known HTTP errors or HTTP errors

Stories

Dev Stories

User Stories

Research

Sources

Readme

• Header:
• Tags:
• Notes:

Proof

Grammar, Spelling, Diagram,

Editorial

• Include
• Edit
• Exclude