Skip to content

Commit

Permalink
feat(readme): detect and score on GitHub (Enterprise)
Browse files Browse the repository at this point in the history 
## v1.0.0 (2018-04-12)

### Features

* **module:readme-inspector:** Verify the existence—and assess the quality—of README files

  > ![quote][icon-octicon-quote] READMEs do more than explain how to use your project. They also
  > explain why your project matters, and what your users can do with it.
  >
  > In your README, try to answer the following questions:
  >
  > * What does this project do?
  > * Why is this project useful?
  > * How do I get started?
  > * Where can I get more help, if I need it?
  >
  > You can use your README to answer other questions, like how you handle
  > contributions, what the goals of the project are, and information about
  > licenses and attribution. If you don’t want to accept contributions, or
  > your project is not yet ready for production, write this information down.
  >
  > "Starting An Open Source Project." Open Source Guides.
  > N. p., 2018. Web. 12 Apr. 2018.

  **Public API**

  _Methods_

  * `authenticate` - Sets GitHub credentials for all subsequent requests.
  * `check` - Attempts to GET and assess a README at a repo-root directory.
  * `getReadmeInfo` - Attempt to GET a README without assessing it.
  * `getReadmeScore` - Assess the quality of a README.

  _Properties_

  * `ReadmeScore` - An API proxy wrapper for the readme-score-api.
  * `api` - A configurable Octokit instance.

  _Documentation_

  Visit <https://github.com/commonality/readme-inspector/#readme> for
  more information about installation, usage, API, version,
  contributing guidelines, and licenses.

  _Commit_

  ([e04a07a](e04a07a)), closes [#1](#1)

---

### Consolidated commit messages

* chore(pkg): update dependencies

  * eslint-plugin-import
  * prettier
  * semantic-release

* ci(windows): add AppVeyor config

  Build and Test on Windows.

* docs(community-standards): 

  * Update all TOCs
  * Update README's API section
  * Update CONTRIBUTING's scripts and dependency tables
  * Update README's installation section to include .env variable
    initialization instructions.
  * Simplify the PULL_REQUEST_TEMPLATE.md

* docs(release): add CHANGELOG

   * Prepare for v1.0.0 release
  * Modify layout for legibility.
  * Add unordered list to citation.

* refactor(config): separate configuration from code 

  Use environment variables for

  1. GH_TOKEN: GitHub personal access token to avoid rate limiting
  2. GA_README_INSPECTOR: Google Analytics tracking code
  3. API_ENDPOINT_README_SCORE: readme-score-api URL

* refactor(inspector): simplify API

  1. API now only exposes five (5) public methods/properties:

    1. api
    2. authenticate
    3. check
    4. getReadmeInfo
    5. readmeScore

  2. Refactor:rename readmeInspector.readmeScore => getReadmeScore

  3. Export ReadmeScore with the readme-inspector module.

* style(badge): fix url endpoint for appveyor

* test(api): log API to console

* test(coverage): hit 100%

GH-1, GH-4, GH-6, GH-7, GH-8

[icon-octicon-quote]: https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/quote.svg
  • Loading branch information
@gregswindle
gregswindle authored Apr 12, 2018
1 parent 8e6c8b0 commit e3583e0
Show file tree
Hide file tree
Showing 39 changed files with 1,607 additions and 460 deletions.
12 changes: 8 additions & 4 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,9 @@
| [dotenv@5.0.1](https://github.com/motdotla/dotenv#readme) | Loads environment variables from .env file | 5.0.1 | BSD-2-Clause | production |
| [got@8.3.0](https://github.com/sindresorhus/got#readme) | Simplified HTTP requests | 8.3.0 | MIT | production |
| [insight@0.10.1](https://github.com/yeoman/insight#readme) | Understand how your tool is being used by anonymously reporting usage metrics to Google Analytics or Yandex.Metrica | 0.10.1 | BSD-2-Clause | production |
| [lodash.camelcase@4.3.0](https://lodash.com/) | The lodash method `_.camelCase` exported as a module. | 4.3.0 | MIT | production |
| [lodash.isstring@4.0.1](https://lodash.com/) | The lodash method `_.isString` exported as a module. | 4.0.1 | MIT | production |
| [lodash.transform@4.6.0](https://lodash.com/) | The lodash method `_.transform` exported as a module. | 4.6.0 | MIT | production |
| [meow@4.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production |
<!-- AUTO-GENERATED-CONTENT:END -->
Expand All @@ -618,7 +621,7 @@
| [eslint-config-scanjs@1.0.0-beta4](https://github.com/mozfreddyb/eslint-config-scanjs#readme) | umbrella config to get scanjs-like functionality from eslint | 1.0.0-beta4 | MPL-2.0 | dev |
| [eslint-config-standard@11.0.0](https://github.com/standard/eslint-config-standard) | JavaScript Standard Style - ESLint Shareable Config | 11.0.0 | MIT | dev |
| [eslint-config-xo@0.20.1](https://github.com/xojs/eslint-config-xo#readme) | ESLint shareable config for XO | 0.20.1 | MIT | dev |
| [eslint-plugin-import@2.10.0](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.10.0 | MIT | dev |
| [eslint-plugin-import@2.11.0](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.11.0 | MIT | dev |
| [eslint-plugin-jsdoc@3.6.2](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.6.2 | BSD-3-Clause | dev |
| [eslint-plugin-json@1.2.0](https://github.com/azeemba/eslint-plugin-json#readme) | Lint JSON files | 1.2.0 | ISC | dev |
| [eslint-plugin-no-unsafe-innerhtml@1.0.16](https://github.com/mozfreddyb/eslint-plugin-no-unsafe-innerhtml/) | custom ESLint rule to disallows unsafe innerHTML, outerHTML and insertAdjacentHTML | 1.0.16 | MPL-2.0 | dev |
Expand All @@ -633,17 +636,18 @@
| [husky@^0.14.3](https://github.com/typicode/husky) | Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...) | 0.14.3 | MIT | dev |
| [jest@22.4.3](http://facebook.github.io/jest/) | Delightful JavaScript Testing. | 22.4.3 | MIT | dev |
| [jest-runner-eslint@0.4.0](https://github.com/jest-community/jest-runner-eslint) | An experimental ESLint runner for Jest | 0.4.0 | MIT | dev |
| [jsdoc@3.5.5](https://github.com/jsdoc3/jsdoc#readme) | An API documentation generator for JavaScript. | 3.5.5 | Apache-2.0 | dev |
| [lec@^1.0.1](https://github.com/iShafayet/lec) | Command Line Wrapper for Line Ending Corrector (An utility that makes sure your files have consistent line endings) | 1.0.1 | MIT | dev |
| [lint-staged@7.0.4](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.4 | MIT | dev |
| [lodash.isundefined@3.0.1](https://lodash.com/) | The modern build of lodash’s `_.isUndefined` as a module. | 3.0.1 | MIT | dev |
| [lodash.noop@3.0.1](https://lodash.com/) | The lodash method `_.noop` exported as a module. | 3.0.1 | MIT | dev |
| [markdown-magic@0.1.21](https://github.com/DavidWells/markdown-magic#readme) | Automatically update markdown files with content from external sources | 0.1.21 | MIT | dev |
| [markdown-magic-dependency-table@1.3.2](https://github.com/camacho/markdown-magic-dependency-table#readme) | Generate table of information about dependencies automatically in markdown | 1.3.2 | MIT | dev |
| [markdown-magic-install-command@1.3.1](https://github.com/camacho/markdown-magic-install-command#readme) | Print install command for markdown file | 1.3.1 | MIT | dev |
| [markdown-magic-package-scripts@1.2.1](https://github.com/camacho/markdown-magic-package-scripts#readme) | Print list of scripts in package.json with descriptions | 1.2.1 | MIT | dev |
| [minami@1.2.3](https://github.com/Nijikokun/minami) | Clean and minimal JSDoc 3 Template / Theme | 1.2.3 | UNLICENSED | dev |
| [nsp@^3.2.1](https://github.com/nodesecurity/nsp#readme) | The Node Security (nodesecurity.io) command line interface | 3.2.1 | Apache-2.0 | dev |
| [prettier@1.11.1](https://prettier.io) | Prettier is an opinionated code formatter | 1.11.1 | MIT | dev |
| [semantic-release@15.1.5](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 15.1.5 | MIT | dev |
| [prettier@1.12.0](https://prettier.io) | Prettier is an opinionated code formatter | 1.12.0 | MIT | dev |
| [semantic-release@15.1.6](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 15.1.6 | MIT | dev |
| [standard-version@4.3.0](https://github.com/conventional-changelog/standard-version#readme) | replacement for `npm version` with automatic CHANGELOG generation | 4.3.0 | ISC | dev |
<!-- AUTO-GENERATED-CONTENT:END -->
Expand Down
Loading

0 comments on commit e3583e0

Please sign in to comment.