Introducing code owners (original) (raw)

While effective code review is essential to every successful project, it’s not always clear who should review files—even with GitHub’s reviewer suggestions. Now repository maintainers can define exactly which people and teams need to review projects using code owners. This new feature automatically requests reviews from the code owners when a pull request changes any owned files.

Requested code owners

How code owners work

To specify code owners, create a file named CODEOWNERS in the repository’s root directory (or in .github/ if you prefer) with the following format:

# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in the repo.
*       @defunkt

# Order is important. The last matching pattern has the most precedence.
# So if a pull request only touches javascript files, only these owners
# will be requested to review.
*.js    @octocat @github/js

# You can also use email addresses if you prefer.
docs/*  docs@example.com

This format may be familiar if you’ve used gitattributes.

With that in place, code owners will automatically be requested for review whenever a pull request touches the files they own.

For projects with more rigorous review processes, we’ve also added a new protected branch option to ensure the right people have a chance to review.

require code owners setting