README.md in codeowners-checker-1.1.1 vs README.md in codeowners-checker-1.1.2

- old
+ new

@@ -15,11 +15,28 @@ $ codeowners-checker config owner <@owner> It will configure `@owner` as the default owner in the config file. +#### Whitelist +If you are just starting to use `codeowners-checker` in your project, you might not have clear ownership defined for all parts of the code. In this case using the checker would be very tedious in the beginning, as it prompts for ownership rules for all files. + +You can still use `codeowners-checker` in this case without the tedium by providing a whitelist. The whitelist contains patterns to ignore when checking files. + +Just place a file called `CODEOWNERS_WHITELIST` next to your `CODEOWNERS` file to enable the whitelist. + +Here is an example: + +``` +# The format of the file follows the format used by .gitignore + +# ignore files under bin +bin/* +``` +For all operations, `codeowners-checker` will ignore files matching the patterns in here. + ### Fetching and validating owners By default, [check](#check-file-consistency) command will validate owners either against the prepopulated file (OWNERS) or against data fetched from github. Format of OWNERS is one owner per line. @@ -192,9 +209,11 @@ ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +Have a look at [spec/README.md](./spec/README.md) for more information about what tools are available when writing tests. ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/toptal/codeowners-checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.