You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ There is also a [companion VSCode Extension](https://github.com/rubyatscale/code
10
10
11
11
## Getting started
12
12
13
-
To get started there's a few things you should do.
13
+
To get started there are a few things you should do.
14
14
15
15
1. Create a `config/code_ownership.yml` file and declare where your files live. Here's a sample to start with:
16
16
@@ -42,7 +42,7 @@ There are five ways to declare code ownership using this gem:
42
42
43
43
### Directory-Based Ownership
44
44
45
-
Directorybased 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.
46
46
47
47
```
48
48
Team
@@ -58,7 +58,7 @@ File annotations are a last resort if there is no clear home for your code. File
58
58
59
59
### Package-Based Ownership
60
60
61
-
Packagebased 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:
62
62
63
63
```yml
64
64
enforce_dependency: true
@@ -92,7 +92,7 @@ unowned_globs:
92
92
93
93
### Javascript Package Ownership
94
94
95
-
Javascript packagebased 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:
96
96
97
97
```json
98
98
{
@@ -112,10 +112,10 @@ js_package_paths:
112
112
- frontend/other_location_for_packages/*
113
113
```
114
114
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.
116
116
117
117
> [!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.
119
119
120
120
```yml
121
121
js_package_paths: []
@@ -184,7 +184,7 @@ If `codeowners_path` is set in `code_ownership.yml` codeowners will use that pat
184
184
CodeOwnership comes with a validation function to ensure the following things are true:
185
185
186
186
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`).
188
188
3. All files have ownership. You can specify in `unowned_globs` to represent a TODO list of files to add ownership to.
189
189
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`.
190
190
@@ -223,7 +223,7 @@ codeownership validate --diff
223
223
224
224
## Development
225
225
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.
0 commit comments