Skip to content

Add CODEOWNERS file for automatic PR review assignment #945

@SashankBhamidi

Description

@SashankBhamidi

Should we add a CODEOWNERS file to automatically assign reviewers to PRs?

Since we're manually assigning reviewers to every PR. GitHub's CODEOWNERS feature can handle this automatically based on which files get changed.

Benefits:

  • PRs automatically get assigned to the right people
  • Clearer sense of who owns what parts of the codebase
  • Faster review process since the right eyes see it immediately

GitHub docs on CODEOWNERS: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Here's a starting point I'm thinking:

# Default owners
* @niccokunzmann @stevepiercy

# Documentation
/docs/ @stevepiercy
*.rst @stevepiercy
*.md @stevepiercy
CONTRIBUTING.md @stevepiercy

# Core calendar logic
/src/icalendar/cal/ @niccokunzmann
/src/icalendar/attr.py @niccokunzmann
/src/icalendar/parser.py @niccokunzmann

# Tests
/src/icalendar/tests/ @niccokunzmann @SashankBhamidi

# CI and infrastructure
/.github/ @niccokunzmann @stevepiercy
/tox.ini @niccokunzmann
/pyproject.toml @niccokunzmann

# Release stuff
/CHANGES.rst @niccokunzmann @stevepiercy

Obviously this is just a proposal. Can be adjusted based on who actually wants to own what areas.

This just sets up smart defaults.

What do you guys think? Should we do this, and if so, does this structure make sense?


Closing criteria by @niccokunzmann

  • invite collaborators
  • document in the maintenance section
    • invitation when becoming a collaborator
    • invitation to review when you become maintainer

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions