From f66b788615ab5f540700ba11517a6a824f960882 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Mon, 18 Jan 2021 13:00:14 -0500 Subject: [PATCH] docs: spelling fixes (#342) --- contributing/bot-architecture.md | 4 ++-- contributing/run-bot-locally.md | 4 ++-- lib/get-user-details.js | 2 +- lib/to-safe-git-reference-name.js | 2 +- privacy-policy.md | 4 ++-- test/unit/parse-comment.test.js | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/contributing/bot-architecture.md b/contributing/bot-architecture.md index 692a091b..beb9862c 100644 --- a/contributing/bot-architecture.md +++ b/contributing/bot-architecture.md @@ -2,11 +2,11 @@ Structure: -- `/src/tasks/processIsssueComment` is the root for incoming comments with the following sub components: +- `/src/tasks/processIssueComment` is the root for incoming comments with the following sub components: - `CommentReply`, deals with responding to a comment - `ContentFiles`, or readmes files that will be re-generated and updated with the table - `OptionsConfig`, the configuration for the bot, and the list of contributions - `Repository`, used by ContentFiles and OptionsConfig for getting files, updating files, creating branches and pull requests - `utils/parse-comment` used for determining the intention of the users comment -Uses [Probot](https://github.com/probot/probot) for incoming events, and communicating/authenticating with github. [Probot docs](https://probot.github.io/docs/), [GitHub oktokit/restjs API docs](https://octokit.github.io/rest.js/) +Uses [Probot](https://github.com/probot/probot) for incoming events, and communicating/authenticating with github. [Probot docs](https://probot.github.io/docs/), [GitHub octokit/restjs API docs](https://octokit.github.io/rest.js/) diff --git a/contributing/run-bot-locally.md b/contributing/run-bot-locally.md index 13e45942..48b8cdcc 100644 --- a/contributing/run-bot-locally.md +++ b/contributing/run-bot-locally.md @@ -48,12 +48,12 @@ PRIVATE_KEY= ## 4. Setup a test github repository/with issues PR -- Setup a repostiory under your name (the name on github where the bot is installed) +- Setup a repository under your name (the name on github where the bot is installed) - Enable issues and pull requests - Create an issue - Comment on the issue: `@all-contributors please add @jakebolam for design` (replace @jakebolam with your username) -To verify if the bot should have seen this goto [your app settings](https://github.com/settings/apps/). On the Advanced Tab, Click the most recent deliever to see the payload. It should look something like this: +To verify if the bot should have seen this goto [your app settings](https://github.com/settings/apps/). On the Advanced Tab, Click the most recent deliver to see the payload. It should look something like this: ![delivery comment](delivery-comment.png). Copy the payload and save it locally in a file called `test-webhook-payload.json` ## 5. Send your first hook diff --git a/lib/get-user-details.js b/lib/get-user-details.js index 7c44220c..c9970108 100644 --- a/lib/get-user-details.js +++ b/lib/get-user-details.js @@ -3,7 +3,7 @@ module.exports = getUserDetails; const { UserNotFoundError } = require("./modules/errors"); async function getUserDetails({ octokit, username }) { - // TODO: optimzation, if commenting user is the user we're adding we can avoid an api call + // TODO: optimization, if commenting user is the user we're adding we can avoid an api call // const commentUser = context.payload.comment.user.login // if (user === commentUser) { // return { diff --git a/lib/to-safe-git-reference-name.js b/lib/to-safe-git-reference-name.js index de120624..7cfa3fe6 100644 --- a/lib/to-safe-git-reference-name.js +++ b/lib/to-safe-git-reference-name.js @@ -4,7 +4,7 @@ function toSafeGitReferenceName(ref) { // Replace fullstops // ~, ^ or : ? * [ // / - // remove @ sybmobls + // remove @ symbols // remove backslash return ref.replace(/[\.\[\~\^\:\?\*\@\/\\]/gi, "-"); } diff --git a/privacy-policy.md b/privacy-policy.md index 534bf44f..c48c4dbd 100644 --- a/privacy-policy.md +++ b/privacy-policy.md @@ -12,11 +12,11 @@ When installing the the app you grant it access to the following three scopes 1. **Read & write access to [pull requests](https://developer.github.com/v3/apps/permissions/#permission-on-statuses)** - The app creates pull reuqests to add new contributors for their contributions. It requires write access to create these pull reuqests. + The app creates pull requests to add new contributors for their contributions. It requires write access to create these pull requests. 2. **Read & write access to [issues](https://developer.github.com/v3/apps/permissions/#permission-on-issues)** - The app responds to comments on issues/pull-reuqests when a user types `@all-contributors` the write perimission is required for this behaviour. + The app responds to comments on issues/pull-requests when a user types `@all-contributors` the write permission is required for this behaviour. 3. **Read & write access to [contents](https://developer.github.com/v3/apps/permissions/#permission-on-contents)** diff --git a/test/unit/parse-comment.test.js b/test/unit/parse-comment.test.js index ee538f7a..41c0405b 100644 --- a/test/unit/parse-comment.test.js +++ b/test/unit/parse-comment.test.js @@ -35,7 +35,7 @@ describe("parseComment", () => { }); }); - test("Basic intent to add - captialized username", () => { + test("Basic intent to add - capitalized username", () => { expect( parseComment(`@all-contributors please add Rbot25_RULES for tool`) ).toEqual({