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.

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

Update fields for repository #2

Open
RichardLitt opened this issue Aug 23, 2017 · 0 comments
Open

Update fields for repository #2

RichardLitt opened this issue Aug 23, 2017 · 0 comments

Comments

@RichardLitt
Copy link
Member

Here is a rough stab at what we want to display.

Specification

Here are what we want to get and display. Written in loose Swagger/JSON imitation. Some checks can be extrapolated - for instance, does description match the description in the package.json.

Organization

{
  "organization": {
    "users": Int,
    "location": String,
    "website": String,
    "repositories": Int,
    "description": String,
    "email": String,
    "pinned_repositories": Array[String]
  }
}

Repository

{
  "name": String,
  "owner": String,
  "stars": Int,
  "issues": Int,
  "pull_requests": Int,
  "description": String,
  "tags": Array[String],
  "contributors": Array[String]
  "badges": {
    "Travis": URL,
    "CircleCI": URL,
    "Coveralls": URL,
    "npm": URL
  },
  "readme": {
    "exists": Bool,
    "greaterThan500Chars": Bool,
    "standardized": Bool,
    "sections": {
      "TOC": Bool,
      "Install": Bool,
      "Usage": Bool,
      "Maintainer(s)": Bool,
      "Contribute": Bool,
      "License": Bool,
      "todos": Bool
    }
  },
  "license": {
    "exists": Bool,
    "matchesReadme": Bool,
    "type": String,
    "licensee": String,
    "year": String
  },
  "contribute": Bool,
  "patents": Bool,
  "AUTHORS": Bool,
  "coc": Bool,
  "package.json": { 
    "description": String,
    "author": String,
    "license": String,
    "homepage": String,
    "bugs": String,
    "git": {Object}
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant