Skip to content

Commit

Permalink
Merge pull request open-telemetry#59 from pellared/approvers-and-code…
Browse files Browse the repository at this point in the history
…owners

Improve maintainers and approvers rules
  • Loading branch information
flands authored Apr 30, 2021
2 parents 98d93cf + d1837db commit 7bc153e
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 3 deletions.
15 changes: 12 additions & 3 deletions docs/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ approval is granted, GDI projects MUST NOT cut a GA release.

## Required Configuration

### Teams

- MUST have a maintainers team
- MUST have `-maintainers` suffix
- MUST include at least two currently full-time Splunkers
- MUST NOT include any non-full-time Splunkers
- SHOULD have an approvers team
- MUST have `-approvers` suffix

### Permissions

- MUST grant `Admin` [permission level](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to maintainers
Expand Down Expand Up @@ -59,9 +68,9 @@ Note: the **upstream** project signal you depend on (if any) MUST be stable
interested in all the details of every change in the project can use the git log for that.
- MUST add the [CODE_OF_CONDUCT.md](templates/CODE_OF_CONDUCT.md)
- MUST add the [CONTRIBUTING.md](templates/CONTRIBUTING.md)
- MUST have a `.github/CODEOWNERS` file with approvers
- MUST include at least two currently full-time Splunkers
- MUST NOT include any non-full-time Splunkers
- MUST have a [.github/CODEOWNERS](templates/.github/CODEOWNERS) file with a maintainers team
- SHOULD have a [.github/workflows/request-reviews.yml](templates/.github/workflows/request-reviews.yml) to automate
requesting reviews from approvers
- MUST have an Apache 2.0 `LICENSE` file
- SHOULD have a `MIGRATING.md` if applicable
- MUST have a `README.md`
Expand Down
5 changes: 5 additions & 0 deletions docs/templates/.github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Learn about CODEOWNERS file format:
# https://help.github.com/en/articles/about-code-owners
#
# Global Owners
* @signalfx/TEAM-maintainers
17 changes: 17 additions & 0 deletions docs/templates/.github/workflows/request-reviews.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Request review on PRs

on:
pull_request:
types: [ opened ]

jobs:
request:
name: Request reviews on opened PRs
runs-on: ubuntu-20.04
steps:
- name: Create PR review request
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr edit ${{ github.event.pull_request.html_url }} \
--add-reviewer signalfx/TEAM-approvers

0 comments on commit 7bc153e

Please sign in to comment.