Commit e3583e0
authored
feat(readme): detect and score on GitHub (Enterprise)
## 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.svg1 parent 8e6c8b0 commit e3583e0
File tree
39 files changed
+1607
-460
lines changed- .github
- config
- lib
- __tests__
- __fixtures__
- http
- 200
- 404
- __mocks__
- @octokit
39 files changed
+1607
-460
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
596 | 596 | | |
597 | 597 | | |
598 | 598 | | |
| 599 | + | |
| 600 | + | |
| 601 | + | |
599 | 602 | | |
600 | 603 | | |
601 | 604 | | |
| |||
618 | 621 | | |
619 | 622 | | |
620 | 623 | | |
621 | | - | |
| 624 | + | |
622 | 625 | | |
623 | 626 | | |
624 | 627 | | |
| |||
633 | 636 | | |
634 | 637 | | |
635 | 638 | | |
| 639 | + | |
636 | 640 | | |
637 | 641 | | |
638 | 642 | | |
639 | | - | |
640 | 643 | | |
641 | 644 | | |
642 | 645 | | |
643 | 646 | | |
| 647 | + | |
644 | 648 | | |
645 | | - | |
646 | | - | |
| 649 | + | |
| 650 | + | |
647 | 651 | | |
648 | 652 | | |
649 | 653 | | |
| |||
0 commit comments