Skip to content
This repository was archived by the owner on May 9, 2025. It is now read-only.

Commit ed1a9a7

Browse files
authored
Merge pull request #66 from open-component-model/PR_vote
New PR Template
2 parents 067f2a6 + 3b9181a commit ed1a9a7

File tree

1 file changed

+157
-0
lines changed

1 file changed

+157
-0
lines changed

.gitvote.yml

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# GitVote configuration file
2+
#
3+
# GitVote will look for it in the following locations (in order of precedence):
4+
#
5+
# - At the root of the repository where the vote was created
6+
# - At the root of the .github repository, for organization wide configuration
7+
#
8+
9+
# Automation (optional)
10+
#
11+
# Create votes automatically on PRs when any of the files affected by the PR
12+
# match any of the patterns provided. Patterns must follow the gitignore
13+
# format (https://git-scm.com/docs/gitignore#_pattern_format).
14+
#
15+
# Each automation rule must include a list of patterns and the profile to use
16+
# when creating the vote. This allows creating votes automatically using the
17+
# desired configuration based on the patterns matched. Rules are processed in
18+
# the order provided, and the first match wins.
19+
#
20+
# automation:
21+
# enabled: true
22+
# rules:
23+
# - patterns:
24+
# - "README.md"
25+
# - "*.txt"
26+
# profile: default
27+
#
28+
automation:
29+
enabled: false
30+
rules:
31+
- patterns: []
32+
profile: profile1
33+
34+
# Configuration profiles (required)
35+
#
36+
# A configuration profile defines some properties of a vote, like its duration,
37+
# the pass threshold or the users who have a binding vote. It's possible to
38+
# define multiple configuration profiles, each with a different set of settings.
39+
#
40+
profiles:
41+
# Default configuration profile
42+
#
43+
# This profile will be used with votes created with the /vote command
44+
default:
45+
# Voting duration (required)
46+
#
47+
# How long the vote will be open
48+
#
49+
# Units supported (can be combined as in 1hour 30mins):
50+
#
51+
# minutes | minute | mins | min | m
52+
# hours | hour | hrs | hrs | h
53+
# days | day | d
54+
# weeks | week | w
55+
#
56+
duration: 5d
57+
58+
# Pass threshold (required)
59+
#
60+
# Percentage of votes in favor required to pass the vote
61+
#
62+
# The percentage is calculated based on the number of votes in favor and the
63+
# number of allowed voters (see allowed_voters field below for more details).
64+
pass_threshold: 50
65+
66+
# Allowed voters (optional)
67+
#
68+
# List of GitHub teams and users who have binding votes
69+
#
70+
# If no teams or users are provided, all repository collaborators will be
71+
# allowed to vote. For organization-owned repositories, the list of
72+
# collaborators includes outside collaborators, organization members that
73+
# are direct collaborators, organization members with access through team
74+
# memberships, organization members with access through default organization
75+
# permissions, and organization owners.
76+
#
77+
# By default, teams' members with the maintainer role are allowed to vote
78+
# as well. By using the `exclude_team_maintainers` option, it's possible to
79+
# modify this behavior so that only teams' members with the member role are
80+
# considered allowed voters. Please note that this option only applies to
81+
# the teams explicitly listed in `allowed_voters/teams`.
82+
#
83+
# Teams names must be provided without the organization prefix.
84+
#
85+
# allowed_voters:
86+
# teams:
87+
# - team1
88+
# users:
89+
# - cynthia-sg
90+
# - tegioz
91+
# exclude_team_maintainers: false
92+
#
93+
allowed_voters:
94+
teams:
95+
- core
96+
users: []
97+
98+
# Periodic status check
99+
# 
100+
# GitVote allows checking the status of a vote in progress manually by
101+
# calling the /check-vote command. The periodic status check option makes
102+
# it possible to automate the execution of status checks periodically. The
103+
# vote status will be published to the corresponding issue or pull request,
104+
# the same way as if the /check-vote command would have been called
105+
# manually.
106+
#
107+
# When this option is enabled, while the vote is open, a status check will
108+
# be run automatically using the frequency configured. Please note that the
109+
# hard limit of one status check per day still applies, so if the command
110+
# has been called manually the automatic periodic run may be delayed.
111+
# Automatic status checks won't be run if the vote will be closed within
112+
# the next hour.
113+
#
114+
# Units supported:
115+
#
116+
# - day / days
117+
# - week / weeks
118+
#
119+
# As an example, using a value of "5 days" would mean that 5 days after the
120+
# vote was created, and every 5 days after that, an automatic status check
121+
# will be run.
122+
#
123+
# periodic_status_check: "5 days"
124+
#
125+
#periodic_status_check: null
126+
periodic_status_check: 5m
127+
128+
# Close on passing
129+
# 
130+
# By default, votes remain open for the configured duration. Sometimes,
131+
# specially on votes that stay open for a long time, it may be preferable
132+
# to close a vote automatically once the passing threshold has been met.
133+
# The close on passing feature makes this possible. Open votes where this
134+
# feature has been enabled will be checked once daily and, if GitVote
135+
# detects that the vote has passed, it will automatically close it.
136+
# 
137+
# close_on_passing: true
138+
#
139+
close_on_passing: false
140+
141+
# Additional configuration profiles
142+
#
143+
# In addition to the default configuration profile, it is possible to add more
144+
# to easily create votes with different settings. To create a vote that uses a
145+
# different profile you can use the command /vote-PROFILE. In the case below,
146+
# the command would be /vote-profile1
147+
#
148+
# Please note that each profile must contain all required fields. The default
149+
# profile is used when using the /vote command, but its values are not used as
150+
# default values when they are not provided on other profiles.
151+
#
152+
profileocm:
153+
duration: 5d
154+
pass_threshold: 50
155+
allowed_voters:
156+
teams:
157+
- ocm-dev

0 commit comments

Comments
 (0)