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.

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

docs: spelling fixes #342

Merged
merged 9 commits into from
Jan 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contributing/bot-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
4 changes: 2 additions & 2 deletions contributing/run-bot-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/get-user-details.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion lib/to-safe-git-reference-name.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ function toSafeGitReferenceName(ref) {
// Replace fullstops
// ~, ^ or : ? * [
// /
// remove @ sybmobls
// remove @ symbols
// remove backslash
return ref.replace(/[\.\[\~\^\:\?\*\@\/\\]/gi, "-");
}
4 changes: 2 additions & 2 deletions privacy-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)**

Expand Down
2 changes: 1 addition & 1 deletion test/unit/parse-comment.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down