Skip to content

Commit c16ddce

Browse files
authored
Fix typos and grammatical issues (#66)
* Fix typos: accordian -> accordion, concantenated -> concatenated * Fix grammatical issues in documentation and comments - README: add missing "run" before bundle install command - README: fix "configured to in" -> "configured in" (two occurrences) - danger_packwerk.rb: fix "It's" -> "Its" (possessive, not contraction)
1 parent 8766d9a commit c16ddce

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`danger-packwerk` integrates [`packwerk`](https://github.com/Shopify/packwerk) with [`danger`](https://github.com/danger/danger) to provide inline comments in PRs related to boundaries in a Rails application.
44

55
## Installation and Basic Usage
6-
Step 1: Add this line to your `Gemfile` (to whatever group your CI uses, as it is not needed in production) and `bundle install`:
6+
Step 1: Add this line to your `Gemfile` (to whatever group your CI uses, as it is not needed in production) and run `bundle install`:
77

88
```ruby
99
gem 'danger-packwerk', group: :test
@@ -30,11 +30,11 @@ In upcoming iterations, we will include other danger checks, including:
3030

3131
## packwerk.check
3232
![This is an image displaying a comment from the Danger github bot after running bin/packwerk check.](docs/check_1.png)
33-
![This is an image displaying a comment from the Danger github bot after running bin/packwerk check with the "quick suggestions" accordian open](docs/check_2.png)
33+
![This is an image displaying a comment from the Danger github bot after running bin/packwerk check with the "quick suggestions" accordion open](docs/check_2.png)
3434

3535
Without any configuration, `packwerk.check` should just work. By default, it will post a maximum of 15 messages in a PR and it will not fail the build.
3636

37-
`packwerk.check` can be configured to in the following ways:
37+
`packwerk.check` can be configured in the following ways:
3838

3939
### Change the message that displays in the markdown
4040
To customize the message in the GitHub comment, pass in `offenses_formatter` to `packwerk.check` in your `Dangerfile`. Here's a simple example:
@@ -108,7 +108,7 @@ You will also most likely want to customize the offenses formatter and provide s
108108

109109
Without any configuration, `package_todo_yml_changes.check` should just work. By default, it will post a maximum of 15 messages in a PR, using default messaging defined within this gem.
110110

111-
`package_todo_yml_changes.check` can be configured to in the following ways:
111+
`package_todo_yml_changes.check` can be configured in the following ways:
112112

113113
### Change the message that displays in the markdown
114114
To customize the message in the GitHub comment, pass in `offenses_formatter` to `package_todo_yml_changes.check` in your `Dangerfile`. Here's a simple example:

lib/danger-packwerk/danger_packwerk.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def check(
6767
repo_url_builder = ->(constant_path) { "#{repo_link}/blob/#{github.pr_json[:head][:ref]}/#{constant_path}" }
6868
org_name = github.pr_json[:base][:repo][:owner][:login]
6969

70-
# This is important because by default, Danger will leave a concantenated list of all its messages if it can't find a commentable place in the
70+
# This is important because by default, Danger will leave a concatenated list of all its messages if it can't find a commentable place in the
7171
# diff to leave its message. This is an especially bad UX because it will be a huge wall of text not connected to the source of the issue.
7272
# Furthermore, dismissing these ensures that something like moving a file from pack to pack does not trigger the danger message. That is,
7373
# the danger message will only be triggered by actual code that someone has actually written in their PR.
@@ -89,7 +89,7 @@ def check(
8989

9090
# If a file has been modified via a rename, then `git.modified_files` will return an array that includes that file's *original* name.
9191
# Packwerk will ignore input files that do not exist, and when the PR only contains renamed Ruby files, that means packwerk check works
92-
# off of an empty list. It's default behavior in that case is to scan *all* files, which can lead to abnormally long run times.
92+
# off of an empty list. Its default behavior in that case is to scan *all* files, which can lead to abnormally long run times.
9393
# To avoid this, we gracefully return if there are no targeted files.
9494
# To avoid false negatives, we also look at renamed files after (above)
9595
file_exists = path.exist?

0 commit comments

Comments
 (0)