Skip to content

Commit 739a83c

Browse files
authored
Fix typos and grammatical issues (#163)
* Fix typos: Javscript -> JavaScript, curren -> current * Fix grammatical issues in README and documentation - "there's a few" -> "there are a few" (subject-verb agreement) - "Directory based" -> "Directory-based" (hyphenate compound modifier) - "Package based" -> "Package-based" (hyphenate compound modifier) - "Javascript package based" -> "JavaScript package-based" - "This defaults `**/`" -> "This defaults to `**/`" (missing preposition) - "is a valid team" -> "are valid teams" (subject-verb agreement) - "make make changes" -> "make changes" (duplicate word)
1 parent 63f4bd3 commit 739a83c

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ There is also a [companion VSCode Extension](https://github.com/rubyatscale/code
1010

1111
## Getting started
1212

13-
To get started there's a few things you should do.
13+
To get started there are a few things you should do.
1414

1515
1. Create a `config/code_ownership.yml` file and declare where your files live. Here's a sample to start with:
1616

@@ -42,7 +42,7 @@ There are five ways to declare code ownership using this gem:
4242

4343
### Directory-Based Ownership
4444

45-
Directory based ownership allows for all files in that directory and all its sub-directories to be owned by one team. To define this, add a `.codeowner` file inside that directory with the name of the team as the contents of that file.
45+
Directory-based ownership allows for all files in that directory and all its sub-directories to be owned by one team. To define this, add a `.codeowner` file inside that directory with the name of the team as the contents of that file.
4646

4747
```
4848
Team
@@ -58,7 +58,7 @@ File annotations are a last resort if there is no clear home for your code. File
5858

5959
### Package-Based Ownership
6060

61-
Package based ownership integrates [`packwerk`](https://github.com/Shopify/packwerk) and has ownership defined per package. To define that all files within a package are owned by one team, configure your `package.yml` like this:
61+
Package-based ownership integrates [`packwerk`](https://github.com/Shopify/packwerk) and has ownership defined per package. To define that all files within a package are owned by one team, configure your `package.yml` like this:
6262

6363
```yml
6464
enforce_dependency: true
@@ -92,7 +92,7 @@ unowned_globs:
9292

9393
### Javascript Package Ownership
9494

95-
Javascript package based ownership allows you to specify an ownership key in a `package.json`. To use this, configure your `package.json` like this:
95+
JavaScript package-based ownership allows you to specify an ownership key in a `package.json`. To use this, configure your `package.json` like this:
9696

9797
```json
9898
{
@@ -112,10 +112,10 @@ js_package_paths:
112112
- frontend/other_location_for_packages/*
113113
```
114114

115-
This defaults `**/`, which makes it look for `package.json` files across your application.
115+
This defaults to `**/`, which makes it look for `package.json` files across your application.
116116

117117
> [!NOTE]
118-
> Javscript package ownership does not respect `unowned_globs`. If you wish to disable usage of this feature you can set `js_package_paths` to an empty list.
118+
> JavaScript package ownership does not respect `unowned_globs`. If you wish to disable usage of this feature you can set `js_package_paths` to an empty list.
119119

120120
```yml
121121
js_package_paths: []
@@ -184,7 +184,7 @@ If `codeowners_path` is set in `code_ownership.yml` codeowners will use that pat
184184
CodeOwnership comes with a validation function to ensure the following things are true:
185185

186186
1. Only one mechanism is defining file ownership. That is -- you can't have a file annotation on a file owned via package-based or glob-based ownership. This helps make ownership behavior more clear by avoiding concerns about precedence.
187-
2. All teams referenced as an owner for any file or package is a valid team (i.e. it's in the list of `CodeTeams.all`).
187+
2. All teams referenced as an owner for any file or package are valid teams (i.e. they're in the list of `CodeTeams.all`).
188188
3. All files have ownership. You can specify in `unowned_globs` to represent a TODO list of files to add ownership to.
189189
4. The `.github/CODEOWNERS` file is up to date. This is automatically corrected and staged unless specified otherwise with `bin/codeownership validate --skip-autocorrect --skip-stage`. You can turn this validation off by setting `skip_codeowners_validation: true` in `config/code_ownership.yml`.
190190

@@ -223,7 +223,7 @@ codeownership validate --diff
223223

224224
## Development
225225

226-
Please add to `CHANGELOG.md` and this `README.md` when you make make changes.
226+
Please add to `CHANGELOG.md` and this `README.md` when you make changes.
227227

228228
## Running specs
229229

spec/lib/code_ownership_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@
488488
end
489489
end
490490

491-
context "haml has annotation (only verifies file is changed, the curren implementation doesn't verify haml files)" do
491+
context "haml has annotation (only verifies file is changed, the current implementation doesn't verify haml files)" do
492492
let(:filename) { 'app/views/my_file.html.haml' }
493493

494494
before do

0 commit comments

Comments
 (0)