Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add instruction how voting automation works #1155

Merged
merged 31 commits into from
Apr 25, 2024
Merged
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
0cc25d9
Added voting.md file
AayushSaini101 Apr 9, 2024
f71e33a
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 9, 2024
2190d83
Merge branch 'master' into Issue-1093-B
derberg Apr 9, 2024
6cee4db
Merge branch 'master' into Issue-1093-B
derberg Apr 9, 2024
07e443f
Update voting.md
AayushSaini101 Apr 10, 2024
fe6c3b0
Update voting doc
AayushSaini101 Apr 10, 2024
4afd81c
Update voting.md
AayushSaini101 Apr 10, 2024
a6fac7e
Update voting.md
AayushSaini101 Apr 11, 2024
95b81aa
Update voting.md
AayushSaini101 Apr 11, 2024
1240bd7
Update voting.md
AayushSaini101 Apr 11, 2024
4292db2
Update voting.md
AayushSaini101 Apr 11, 2024
7bd2ed4
Update voting.md
AayushSaini101 Apr 11, 2024
697099b
Update voting.md
AayushSaini101 Apr 11, 2024
175319e
Update voting doc
AayushSaini101 Apr 12, 2024
82fa0c9
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 12, 2024
1921519
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 14, 2024
647d2f7
Improve suggestions
AayushSaini101 Apr 15, 2024
70de86e
Update voting.md
AayushSaini101 Apr 15, 2024
9926395
Rephrase git-vote to Git Vote
AayushSaini101 Apr 15, 2024
76991ab
Update voting.md
AayushSaini101 Apr 15, 2024
991f34e
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 15, 2024
f06f6a3
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 15, 2024
e15ae4a
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 17, 2024
5e44df1
Update voting.md
AayushSaini101 Apr 18, 2024
4f28b95
punctuation correction
thulieblack Apr 18, 2024
e3e42c3
Update voting.md
thulieblack Apr 18, 2024
b90b6e3
Merge branch 'master' into Issue-1093-B
asyncapi-bot Apr 19, 2024
1b7d67b
Update voting.md
AayushSaini101 Apr 19, 2024
c625991
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 22, 2024
07adb63
Merge branch 'master' into Issue-1093-B
AayushSaini101 Apr 23, 2024
e2c6600
Merge branch 'asyncapi:master' into Issue-1093-B
AayushSaini101 Apr 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions voting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## Overview
derberg marked this conversation as resolved.
Show resolved Hide resolved

In the [search for the right governance model](https://www.asyncapi.com/blog/governance-motivation), we ended up defining a Technical Steering Committee (TSC) that can help make decisions related to the entire AsyncAPI Initiative and not only a specific repository. TSC voting is described in the official [Charter](https://github.com/asyncapi/community/blob/master/CHARTER.md#4-tsc-voting).

To make the voting process easier with proper automation, we use [**Git Vote**](https://github.com/cncf/gitvote) bot.

### Voting Location
AayushSaini101 marked this conversation as resolved.
Show resolved Hide resolved

- Voting must only take place in the [community](https://github.com/asyncapi/community) repository.
- Voting automation works only with GitHub Issues and Pull Requests.

The Discussions should only be used for initial discussion, brainstorming ideas, or seeking initial support.

In the majority of cases, topics we vote on introduce new rules or ways of doing things. This implies that proper community documentation is needed for these topics. We recommend using Pull Requests instead of Issues to conduct voting on a topic, as it allows you to provide context and finalize documentation.

### Voting Rules

* Only votes from [TSC members](https://www.asyncapi.com/community/tsc) are counted. You are still encouraged to participate in voting, even if your vote is not binding.
* TSC members have at least 7 calendar days to vote. As a community, we did not set an exact voting deadline and only have a rule that you can translate into: "Just be nice and give people at least 7 days to get familiar with the topic so they can vote." Our automation is set for 4 weeks to take into account all possible limitations related to holidays and other events.
* TSC members can skip some votes, although, if you do not have an opinion, please participate with 👀 to indicate that you saw a vote but you have no opinion and abstain. There is one strict rule, though: if you do not participate in voting within three months, you will stop being a TSC member. It has nothing to do, though, with your maintainer responsibilities.
* The vote is completed when more than 50% of the voting is in favor.

### Voting Process

#### Start Voting

1. The TSC member adds a `/vote` comment to an Issue or a Pull Request.
2. The Git Vote bot creates a comment with instructions on how the voting should be done. It is based on 👍🏼 , 👎🏼 and 👀 emojis. You can still put comments or suggestions.
3. The AsyncAPI bot adds a `vote` label, making it easier to extract information about voted topics and participation.

#### Check Status

1. Anyone can add a `/check-vote` comment to an Issue or a Pull Request.
2. The Git Vote bot creates a comment with an update on how many binding votes were provided. And how much the percentage is required to finish the voting process.

### Cancel Voting

1. The TSC member adds `/cancel-vote` comment to an Issue or a Pull Request.
2. The Git Vote bot creates a comment.
3. The AsyncAPI bot removes the `vote` label.

### Finish Voting

Voting cannot be concluded with a comment; it ends when more than half of the users with binding votes say yes or when the deadline passes.

The Git Vote bot adds a comment that voting is completed.

### Note

* As per the [Charter](./CHARTER.md), a quorum is not needed. However, Git Vote has technical limitations, and a quorum should be reached. That's why we allocate 4 weeks for voting, and it's important to actively encourage participation to ensure that the quorum (where votes cast exceed 50% of eligible voters) is met.
* The abstain votes are included in the total number of votes; they are not removed.
* At present, Git Vote is enabled in the community repo only, and the Git Vote bot handles all voting processes. We will add Git Vote to other projects in the future.
Loading