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.

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

Jump to bottom

feat(readme): detect and score GitHub (Enterprise) READMEs #1

Closed
4 tasks done
gregswindle opened this issue Apr 9, 2018 · 1 comment · Fixed by #4
Closed
4 tasks done

feat(readme): detect and score GitHub (Enterprise) READMEs #1

gregswindle opened this issue Apr 9, 2018 · 1 comment · Fixed by #4
Assignees
@gregswindle
Labels
priority: medium Will add consumer value when released. type: build Changes to product build. type: ci Continuous integration config file or script changes (e.g., travis, circle, cypress). type: docs Add, edit, or delete instructional material. type: feature Valuable new or enhanced functionality. ⇧ Bumps the MINOR semver. type: test Adding, correcting, or improving tests (coverage).
Milestone
GitHub (Enterpris...

Comments

@gregswindle
Copy link
Contributor

gregswindle commented Apr 9, 2018 •
edited
Loading

1. User story summary

As a repository owner or maintainer,
I want to ensure my product has a well-written README
In order to introduce potential consumers to my product.

2. Acceptance criteria

When given the URL to a repository,

  • 1. The presence of a README is declared.
  • 2. The absence of README is declared.
  • 3. READMEs are scored according to the readme-score-api (as used by the CoCoPods registry).
  • 4. Configuration variables are separated from source code with environment (env) variables.
@gregswindle gregswindle added the help wanted Contributions welcome or extra attention needed. label Apr 9, 2018
@gregswindle gregswindle self-assigned this Apr 9, 2018
@gregswindle gregswindle added priority: medium Will add consumer value when released. type: docs Add, edit, or delete instructional material. type: ci Continuous integration config file or script changes (e.g., travis, circle, cypress). type: feature Valuable new or enhanced functionality. ⇧ Bumps the MINOR semver. type: build Changes to product build. type: test Adding, correcting, or improving tests (coverage). and removed help wanted Contributions welcome or extra attention needed. labels Apr 9, 2018
gregswindle added a commit that referenced this issue Apr 9, 2018
@gregswindle
docs(community-standards): update TOCs
52b9bdb 
GH-1
gregswindle added a commit that referenced this issue Apr 9, 2018
@gregswindle
ci(windows): add AppVeyor config
f968b26 
Build and Test on Windows.

GH-1
gregswindle added a commit that referenced this issue Apr 9, 2018
@gregswindle
ci(packages): enable greenkeeper (#3)
8e6c8b0 
* docs(readme): add Greenkeeper badge

* docs(community-standards): update TOCs

GH-1

* ci(windows): add AppVeyor config

Build and Test on Windows.

GH-1
gregswindle added a commit that referenced this issue Apr 9, 2018
@gregswindle
ci(windows): add AppVeyor config
cb76554 
Build and Test on Windows.

GH-1
gregswindle added a commit that referenced this issue Apr 9, 2018
@gregswindle
docs(readme): update API section
8888789 
GH-1
gregswindle added a commit that referenced this issue Apr 9, 2018
@gregswindle
docs(readme): update sections for TOC
a4f3e8f 
GH-1
gregswindle added a commit that referenced this issue Apr 10, 2018
@gregswindle
feat(inspector): simplify API
e04a07a 
BREAKING CHANGE

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

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

GH-1
@gregswindle gregswindle mentioned this issue Apr 10, 2018
Merged
3 tasks
gregswindle added a commit that referenced this issue Apr 10, 2018
@gregswindle
test(coverage): inch towards 100%
f8d77ad 
Still have two failures and incomplete coverage for index.js

GH-1
gregswindle added a commit that referenced this issue Apr 11, 2018
@gregswindle
test(coverage): hit 100%
2fb9233 
Document README.

GH-1
gregswindle added a commit that referenced this issue Apr 11, 2018
@gregswindle
docs(readme): update API section
ffbb0ab 
GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
refactor(config): move hard-coded values to env vars
b88da83 
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:rename readmeInspector.readmeScore => getReadmeScore

Update README's installation section to include .env variable
initialization instructions.

Simplify the PULL_REQUEST_TEMPLATE.md

GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
chore(pkg): update eslint-plugin-import
2f79bd1 
Export ReadmeScore with the readme-inspector module.

GH-1,GH-8
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
style(badge): fix url endpoint for appveyor
a2a7d05 
GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
test(api): log API to console
f2a82b3 
GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
chore(release): add CHANGELOG
f7daad8 
Prepare for v1.0.0 release

GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
docs(changelog): format CHANGELOG
c702af3 
Modify layout for legibility.

GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
docs(changelog): add unordered list to citation
1bd02f1 
GH-1
gregswindle added a commit that referenced this issue Apr 12, 2018
@gregswindle
feat(readme): detect and score on GitHub (Enterprise)
e3583e0 
## 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
@gregswindle
Copy link
Contributor Author

🎉 This issue has been resolved in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gregswindle gregswindle

Labels
priority: medium Will add consumer value when released. type: build Changes to product build. type: ci Continuous integration config file or script changes (e.g., travis, circle, cypress). type: docs Add, edit, or delete instructional material. type: feature Valuable new or enhanced functionality. ⇧ Bumps the MINOR semver. type: test Adding, correcting, or improving tests (coverage).
Projects
None yet
Milestone
GitHub (Enterprise) repo README inspe...
Development

Successfully merging a pull request may close this issue.

feat(readme): detect and score GitHub (Enterprise) READMEs commonality/readme-inspector
1 participant
@gregswindle