Skip to content

Commit

Permalink
Add CODEOWNERS and PULL_REQUEST_TEMPLATE files
Browse files Browse the repository at this point in the history
Persons specified in CODEOWNERS file will be automatically added as reviewers,
whenever new PRs are opened, depending on affected folder.
In addition to Code Owners, other reviewers can be added to each PR.
CODEOWNERS file can be different from one branch to another.
All new PRs will require the approval of at least one code owner.

PULL_REQUEST_TEMPLATE.md will populate all new PR description field.
Beside PR description, it contains a list of checkboxes, ensuring everyone
follows the same guidelines and enforces best practices.
Pull Request Template applies for PRs against all protected branches.

Both files got added in .github

Signed-off-by: Stefan Raus <[email protected]>
  • Loading branch information
SRaus committed Mar 22, 2024
1 parent d692a52 commit 3200f84
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This document lists the code owners for libad9361-iio repo sources, being used
# whenever new Pull Requests are created.
# - People listed in CODEOWNERS are automatically added as reviewers to all
# PRs open to branches containing this file, depending on the changed folders.
# - In addition to Code Owners, other reviewers can be added.
# - There can be different code owners for different branches.
# - PRs will require the approval of at least one code owner.
#
# For more details, you can refer to
# https://github.blog/2017-07-06-introducing-code-owners/
#
# The format of CODEOWNERS is: <pattern> + <mail address of one/more owners>
# In case of multiple matches, the last pattern matched will take precedence.

##### Global code owners (for folders with no later match) #####
* [email protected] [email protected] [email protected]

##### Code owners for CI related files/folders #####
/CI/ [email protected] [email protected] [email protected] [email protected] [email protected]
azure-pipelines.yml [email protected] [email protected] [email protected] [email protected] [email protected]
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## PR Description

- Please replace this comment with a summary of your changes, and add any context
necessary to understand them. List any dependencies required for this change.
- To check the checkboxes below, insert a 'x' between square brackets (without
any space), or simply check them after publishing the PR.
- If you changes include a breaking change, please specify dependent PRs in the
description and try to push all related PRs simultaneously.

## PR Type
- [ ] Bug fix (a change that fixes an issue)
- [ ] New feature (a change that adds new functionality)
- [ ] Breaking change (a change that affects other repos or cause CIs to fail)

## PR Checklist
- [ ] I have followed the coding standards and guidelines
- [ ] I have conducted a self-review of my own code changes
- [ ] I have commented new code, particulary complex or unclear areas
- [ ] I have built libad9361-iio and check no new warnings/errors were introduced
- [ ] I have checked that my changes did not broke components that use libad9361-iio as dependency
- [ ] I have updated the documentation accordingly (GitHub Pages, READMEs, etc)

0 comments on commit 3200f84

Please sign in to comment.