Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the .github/CODEOWNERS file #614

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# Global rule:
* @microsoft/akvelon-build-task-team @microsoft/azure-pipelines-platform

# Specific rules for different directories or file types
design/ @microsoft/design-team
*.md @microsoft/documentation-team

# Fallback owners for specific directories or file types
templates/ @microsoft/templates-team

# Grouped similar rules together using wildcard patterns
*.yml @microsoft/yml-team
*.json @microsoft/json-team
13 changes: 13 additions & 0 deletions design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,16 @@ The design docs within this repo are created at different times during the devel
The design docs in this repo may not represent the current state of an Azure Pipelines feature.

For the most upto date information about a feature refer to the [Azure Pipeline Docs](https://docs.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops) and specifically the [Azure Pipeline Yaml Reference](https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema?view=azure-devops&tabs=schema)

## Improving the .github/CODEOWNERS file

This section provides ideas for improving, extending, completing, or simplifying the `.github/CODEOWNERS` file.

### Summary of Ideas

1. **Add more specific rules**: Instead of having a global rule for all files, you can add more specific rules for different directories or file types. For example, you can add a rule for `design/` directory to assign specific code owners for design documents. This can help in better management and review of code changes.
2. **Use wildcard patterns**: You can use wildcard patterns to match specific file types or directories. For example, you can use `*.md` to match all markdown files and assign specific code owners for documentation. This can help in organizing code ownership based on file types.
3. **Add fallback owners**: You can add fallback owners for specific directories or file types. For example, you can add a fallback owner for all files in the `templates/` directory to ensure that there is always someone responsible for reviewing changes in that directory.
4. **Simplify the file**: If the file becomes too complex with many specific rules, you can simplify it by grouping similar rules together or using wildcard patterns. This can help in maintaining the file and making it easier to understand.

For more details, refer to the relevant section in the `.github/CODEOWNERS` file.