Skip to content

Commit d94f812

Browse files
author
Tihomir Surdilovic
authored
Adding maintainers and maintainers guidelines docs (#5)
* Adding maintainers and maintainers guidelines docs Signed-off-by: Tihomir Surdilovic <tsurdilo@redhat.com> * fix typo
1 parent e40dc67 commit d94f812

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

MAINTAINERS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Serverless Workflow Go SDK Maintainers
2+
3+
* [Ricardo Zanini](https://github.com/ricardozanini)

maintainer_guidelines.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Maintainer's Guide
2+
3+
## Tips
4+
5+
Here are a few tips for repository maintainers.
6+
7+
* Stay on top of your pull requests. PRs that languish for too long can become difficult to merge.
8+
* Work from your own fork. As you are making contributions to the project, you should be working from your own fork just as outside contributors do. This keeps the branches in github to a minimum and reduces unnecessary CI runs.
9+
* Try to proactively label issues with backport labels if it's obvious that a change should be backported to previous releases.
10+
* When landing pull requests, if there is more than one commit, try to squash into a single commit. Usually this can just be done with the GitHub UI when merging the PR. Use "Squash and merge".
11+
* Triage issues once in a while in order to keep the repository alive. During the triage:
12+
* If some issues are stale for too long because they are no longer valid/relevant or because the discussion reached no significant action items to perform, close them and invite the users to reopen if they need it.
13+
* If some PRs are no longer valid but still needed, ask the user to rebase them
14+
* If some issues and PRs are still relevant, use labels to help organize tasks
15+
* If you find an issue that you want to create a fix for and submit a pull request, be sure to assign it to yourself so that others maintainers don't start working on it at the same time.
16+
17+
## Branch Management
18+
19+
The `master` branch is is the bleeding edge. New major versions of the module
20+
are cut from this branch and tagged. If you intend to submit a pull request
21+
you should use `master HEAD` as your starting point.
22+
23+
Each major release will result in a new branch and tag. For example, the
24+
release of version 1.0.0 of the project results in a `v1.0.0` tag on the
25+
release commit, and a new branch `release-1.y.z` for subsequent minor and patch
26+
level releases of that major version if necessary. However, development will continue
27+
apace on `master` for the next major version - e.g. 2.0.0. Version branches
28+
are only created for each major version. Minor and patch level releases
29+
are simply tagged.

0 commit comments

Comments
 (0)