Skip to content

Commit 57020b7

Browse files
npalmrjaegers
andauthored
chore: add maintainers guide (#4348)
Co-authored-by: Ron <[email protected]>
1 parent b4c3f9d commit 57020b7

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

MAINTAINERS.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,36 @@
1-
Niek Palm <[email protected]>
1+
# Maintainers guide
2+
3+
Roles and responsibilities of the maintainers of the project.
4+
5+
## Maintainers
6+
7+
| Name | GitHub | Affiliation |
8+
| --------- | -------- | ----------- |
9+
| Niek Palm | [@npalm] | Philips |
10+
11+
## Responsibilities
12+
13+
### Pull Requests
14+
15+
Maintainers are responsible to review and merge pull requests. Currently we have no end-to-end automation to test a pull request. Here a short guide how to review a pull request.
16+
17+
#### Guidelines
18+
19+
- Check if changes are implemented for both modules (root and multi-runner)
20+
- Check backwards compatibility, we strive to keep the module compatible with previous versions
21+
- Check complexity of the changes, if the changes are too complex. Think about how does impact the PR on the long term maintaining the module.
22+
- Check all pipelines are passing, if not request the author to fix the issues
23+
- In case any new dependency is added ensure we can trust and rely on the dependency. Make explicit comments in the PR that the dependency is safe to use.
24+
25+
#### Test
26+
27+
The following steps needs to be applied to test a PR
28+
29+
1. Check to which deployment scenario the PR belongs to: "single runner (default example)" or "multi runner"
30+
2. Deploy per scenario the main branch
31+
3. Apply the PR to the deployment. Check output for breaking changes such as destroying resources containing state.
32+
4. Test the PR by running a workflow
33+
34+
### Security
35+
36+
Act on security issues as soon as possible. If a security issue is reported.

0 commit comments

Comments
 (0)