You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,27 +2,10 @@
2
2
3
3
[![PRs Welcome][makeapullrequest-image]][makeapullrequest-url] We welcome contributors, issues, and pull requests.
4
4
5
-
<blockquote>
6
-
<dfn><strong>Contributions</strong> start with <strong>community conversations</strong> that lead to <strong>positive change.</strong></dfn> <code>readme-inspector's</code> open source collaboration model has five steps:
7
-
8
-
<dl>
9
-
<dt>1. <dfn>Issues</dfn></dt>
10
-
<dd>Start community conversations that determine whether proposed changes add value and should be made.</dd>
11
-
<dt>2. <dfn>Pull Requests (PRs)</dfn></dt>
12
-
<dd>Inform and manage community code reviews for approved changes in-progress.</dd>
13
-
<dt>3. <dfn>Merges</dfn></dt>
14
-
<dd>Incorporate approved PR changes into the product.</dd>
15
-
<dt>4. <dfn>Releases</dfn></dt>
16
-
<dd>Make changes available for community consumption.</dd>
17
-
<dt>5. <dfn>Support</dfn></dt>
18
-
<dd>Improves the product with refactorings and defect fixes.</dd>
19
-
</dl>
20
-
</blockquote>
21
-
22
5
## Table of contents
23
6
24
7
<!-- ⛔️ AUTO-GENERATED-CONTENT:START (TOC:excludeText=Table of contents) -->
25
-
-[1. Issues](#1-issues)
8
+
-[1. Contributions: a brief "how-to"](#1-contributions-a-brief-how-to)
26
9
*[1.1. Create Issues for feature requests and defects.](#11-create-issues-for-feature-requests-and-defects)
27
10
*[1.2. Format titles with **`type(scope): subject`**.](#12-format-titles-with-typescope-subject)
28
11
*[1.3. Fill out the issue template.](#13-fill-out-the-issue-template)
@@ -72,7 +55,24 @@
72
55
-[9. **Licensing**](#9-licensing)
73
56
<!-- ⛔️ AUTO-GENERATED-CONTENT:END -->
74
57
75
-
## 1. Issues
58
+
## 1. Contributions: a brief "how-to"
59
+
60
+
<blockquote>
61
+
<dfn><strong>Contributions</strong> start with <strong>community conversations</strong> that lead to <strong>positive change.</strong></dfn> <code>readme-inspector's</code> open source collaboration model has five steps:
62
+
63
+
<dl>
64
+
<dt>1. <dfn>Issues</dfn></dt>
65
+
<dd>Start community conversations that determine whether proposed changes add value and should be made.</dd>
66
+
<dt>2. <dfn>Pull Requests (PRs)</dfn></dt>
67
+
<dd>Inform and manage community code reviews for approved changes in-progress.</dd>
68
+
<dt>3. <dfn>Merges</dfn></dt>
69
+
<dd>Incorporate approved PR changes into the product.</dd>
70
+
<dt>4. <dfn>Releases</dfn></dt>
71
+
<dd>Make changes available for community consumption.</dd>
72
+
<dt>5. <dfn>Support</dfn></dt>
73
+
<dd>Improves the product with refactorings and defect fixes.</dd>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,13 @@
2
2
3
3
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
> <imgalign="middle"alt="markdown"height="50"width="50"src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/markdown.svg"> Inspect GitHub (and GitHub Enterprise) repositories for the presence and quality of READMEs.
3
+
> <imgalign="middle"alt="markdown"height="50"width="50"src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/markdown.svg"> Inspect GitHub (Enterprise) repositories for the presence and quality of READMEs.
4
4
5
5
[![The MIT License][license-image]][license-url]
6
6
[![FOSSA Status][fossa-image]][fossa-url]
@@ -92,8 +92,8 @@ GITHUB_ACCESS_TOKEN=
92
92
Defines a schema of what variables should be defined in the combination of
> [![beaker][octicon-beaker] Test `readme-inspector` in your Web browser ![link-external][octicon-link-external]][runkit-readme-inspector-url].
256
279
>
257
-
> [![gear][octicon-gear] View the full API docs for details](docs/readme-inspector/1.0.2/ReadmeAppraisal.html).
280
+
> [![gear][octicon-gear] View the full API docs for details![link-external][octicon-link-external]][api-docs-url].
258
281
259
282
The `readmeInspector` module detects whether or not a README document exists at the root of a GitHub or GitHub Enterprise repository. If a README exists, it can evaluate the README's quality and provide a numerical score from 0 to 100, where 0 is the lowest quality and 100 is the highest.
260
283
@@ -265,15 +288,19 @@ The `readmeInspector` module detects whether or not a README document exists at
265
288
> 1. If you can see the information by visiting the site without being logged in, you don't have to be authenticated to retrieve the same information through the API.
266
289
> 1. If you want to change data, you have to be authenticated.
267
290
>
291
+
> Note: authenticate is synchronous because it only sets the credentials for the following requests.
292
+
>
268
293
> octokit/rest.js. (2018). GitHub. Retrieved 21 March 2018, from <https://github.com/octokit/rest.js#authentication>![link-external][octicon-link-external]
0 commit comments