From 1635f64b55e410366c69bcd1f9073f779c9549b6 Mon Sep 17 00:00:00 2001 From: Douglas Eichelberger Date: Thu, 5 Mar 2026 15:02:57 -0800 Subject: [PATCH 1/2] Fix typos: Javscript -> JavaScript, curren -> current --- README.md | 2 +- spec/lib/code_ownership_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1f62851..1876c0e 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ js_package_paths: This defaults `**/`, which makes it look for `package.json` files across your application. > [!NOTE] -> 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. +> 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. ```yml js_package_paths: [] diff --git a/spec/lib/code_ownership_spec.rb b/spec/lib/code_ownership_spec.rb index 6abb7d2..3666c1c 100644 --- a/spec/lib/code_ownership_spec.rb +++ b/spec/lib/code_ownership_spec.rb @@ -488,7 +488,7 @@ end end - context "haml has annotation (only verifies file is changed, the curren implementation doesn't verify haml files)" do + context "haml has annotation (only verifies file is changed, the current implementation doesn't verify haml files)" do let(:filename) { 'app/views/my_file.html.haml' } before do From b2e7f4a55477d50e3c0c828e5c78096490e94f92 Mon Sep 17 00:00:00 2001 From: Douglas Eichelberger Date: Thu, 5 Mar 2026 15:03:33 -0800 Subject: [PATCH 2/2] 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) --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1876c0e..25e25c2 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ There is also a [companion VSCode Extension](https://github.com/rubyatscale/code ## Getting started -To get started there's a few things you should do. +To get started there are a few things you should do. 1. Create a `config/code_ownership.yml` file and declare where your files live. Here's a sample to start with: @@ -42,7 +42,7 @@ There are five ways to declare code ownership using this gem: ### Directory-Based Ownership -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. +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. ``` Team @@ -58,7 +58,7 @@ File annotations are a last resort if there is no clear home for your code. File ### Package-Based Ownership -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: +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: ```yml enforce_dependency: true @@ -92,7 +92,7 @@ unowned_globs: ### Javascript Package Ownership -Javascript package based ownership allows you to specify an ownership key in a `package.json`. To use this, configure your `package.json` like this: +JavaScript package-based ownership allows you to specify an ownership key in a `package.json`. To use this, configure your `package.json` like this: ```json { @@ -112,7 +112,7 @@ js_package_paths: - frontend/other_location_for_packages/* ``` -This defaults `**/`, which makes it look for `package.json` files across your application. +This defaults to `**/`, which makes it look for `package.json` files across your application. > [!NOTE] > 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. @@ -184,7 +184,7 @@ If `codeowners_path` is set in `code_ownership.yml` codeowners will use that pat CodeOwnership comes with a validation function to ensure the following things are true: 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. -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`). +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`). 3. All files have ownership. You can specify in `unowned_globs` to represent a TODO list of files to add ownership to. 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`. @@ -223,7 +223,7 @@ codeownership validate --diff ## Development -Please add to `CHANGELOG.md` and this `README.md` when you make make changes. +Please add to `CHANGELOG.md` and this `README.md` when you make changes. ## Running specs