Skip to content

Commit 39879ab

Browse files
committed
Add CODEOWNERS and PULL_REQUEST_TEMPLATE files
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 to PRs against all protected branches. Both files got added in .github Signed-off-by: Stefan Raus <[email protected]>
1 parent c6aa03f commit 39879ab

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

Diff for: .github/CODEOWNERS

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# This document lists the code owners for iio-oscilloscope repo sources,
2+
# being used whenever new Pull Requests are created.
3+
# - People listed in CODEOWNERS are automatically added as reviewers to the
4+
# PRs open to branches containing this file, depending on the touched folders.
5+
# - In addition to Code Owners, other reviewers can be added.
6+
# - There can be set different code owners for different branches.
7+
# - PRs will require the approval of at least one code owner.
8+
#
9+
# For more details, you can refer to
10+
# https://github.blog/2017-07-06-introducing-code-owners/
11+
#
12+
# The format of CODEOWNERS is: <pattern> + <mail address of one/more owners>
13+
# In case of multiple matches, the last pattern matched will take precedence.
14+
15+
##### Global code owners (for folders with no later match) #####
16+
17+
18+
##### Code owners for CI related files and folders #####
19+
20+

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## PR Description
2+
3+
- Please replace this comment with a summary of your changes, and add any context
4+
necessary to understand them. List any dependencies required for this change.
5+
- To check the checkboxes below, insert a 'x' between square brackets (without
6+
any space), or simply check them after publishing the PR.
7+
- If you changes include a breaking change, please specify dependent PRs in the
8+
description and try to push all related PRs simultaneously.
9+
10+
## PR Type
11+
- [ ] Bug fix (a change that fixes an issue)
12+
- [ ] New feature (a change that adds new functionality)
13+
- [ ] Breaking change (a change that affects other repos or cause CIs to fail)
14+
15+
## PR Checklist
16+
- [ ] I have followed the coding standards and guidelines
17+
- [ ] I have conducted a self-review of my own code changes
18+
- [ ] I have commented new code, particulary complex or unclear areas
19+
- [ ] I have checked in CI output that no new warnings/errors got introduced
20+
- [ ] I have updated documentation accordingly (GitHub Pages, READMEs, etc)

0 commit comments

Comments
 (0)