You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: GOVERNANCE.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,31 +45,31 @@ Functionality that is out of current scope:
45
45
## Contributor
46
46
47
47
* Definition: a user who has written/commented at least one issue, worked to label/triage issues, written a blog post, given a talk, etc.
48
-
* How this role is recognized: there is no central list of contributors / no formal recognition for contributors.
48
+
* How this role is recognized: there is no central list of Contributors / no formal recognition for Contributors.
49
49
50
-
## Project member
50
+
## Project Member
51
51
52
-
* Definition: some one who has submitted at least one PR with substantial contributions, that has been merged into master. PRs improving documentation are welcome, and substantial contributions to the docs should count toward membership, but minor contributions such as spelling fixes do not count toward membership.
53
-
* How to obtain this role: any user/contributor can become a member by submitting a PR with substantial contributions, then having it reviewed and merged into master. Contributors who have written issues should be encouraged to submit their first PR to become a project member. Contributors can look at https://github.com/Rdatatable/data.table/labels/beginner-task for easy issues to work on.
54
-
* How this role is recognized: Members are credited via role="ctb" in DESCRIPTION (so they appear in Author list on CRAN), and they are added to https://github.com/orgs/Rdatatable/teams/project-members so they can create new branches in the Rdatatable/data.table GitHub repo. They also appear on https://github.com/Rdatatable/data.table/graphs/contributors (Contributions to master, excluding merge commits).
52
+
* Definition: some one who has submitted at least one PR with substantial contributions, that has been merged into master. PRs improving documentation are welcome, and substantial contributions to the docs should count toward Project Membership, but minor contributions such as spelling fixes do not count toward Project Membership.
53
+
* How to obtain this role: anybody can become a Project Member by submitting a PR with substantial contributions, then having it reviewed and merged into master. Contributors who have written issues should be encouraged to submit their first PR to become a Project Member. Contributors can look at https://github.com/Rdatatable/data.table/labels/beginner-task for easy issues to work on.
54
+
* How this role is recognized: Project Members are credited via role="ctb" in DESCRIPTION (so they appear in Author list on CRAN), and they are added to https://github.com/orgs/Rdatatable/teams/project-members so they can create new branches in the Rdatatable/data.table GitHub repo. They also appear on https://github.com/Rdatatable/data.table/graphs/contributors (Contributions to master, excluding merge commits).
55
55
56
56
## Reviewer
57
57
58
-
* Definition: a member who has volunteered to do code reviews for some features/files.
59
-
* How to obtain this role: after one or more significant PRs to a given file, a member should be invited to add their name as a reviewer of that file in CODEOWNERS, and after that is merged into master, then they are considered a reviewer.
60
-
* How this role is recognized: same credit in DESCRIPTION as a regular member, role="ctb" (so they appear in Author list on CRAN).
58
+
* Definition: a Project Member who has volunteered to do code reviews for some features/files.
59
+
* How to obtain this role: after one or more significant PRs to a given file, a Project Member should be invited to add their name as a reviewer of that file in CODEOWNERS, and after that is merged into master, then they are considered a Reviewer.
60
+
* How this role is recognized: same credit in DESCRIPTION as a regular Project Member, role="ctb" (so they appear in Author list on CRAN).
61
61
* Note: having your name in CODEOWNERS does not give any special permission, but it does mean that you will be notified whenever there is a new PR with changes to that file.
62
62
63
63
## Committer
64
64
65
65
* Definition: permission to commit to, and merge PRs into, master branch.
66
-
* How to obtain this role: after a reviewer has a consistent history of careful reviews of others' PRs, then a current Committer should ask all other current Committers if they approve promoting the Reviewer to Committer, and it should be done if there is Consensus among active Committers.
66
+
* How to obtain this role: after a Reviewer has a consistent history of careful reviews of others' PRs, then a current Committer should ask all other current Committers if they approve promoting the Reviewer to Committer, and it should be done if there is Consensus among active Committers.
67
67
* How this role is recognized: credited via role="aut" in DESCRIPTION (so they appear in Author list on CRAN), and added to https://github.com/orgs/Rdatatable/teams/committers which gives permission to merge PRs into master branch.
68
68
69
-
## CRAN maintainer
69
+
## CRAN Maintainer
70
70
71
71
* Definition: in charge of communication with CRAN. Responsible for submitting releases to CRAN on a regular basis, and for responding to requests from CRAN.
72
-
* How to obtain this role: (1) merge into master a PR adding role="cre" to DESCRIPTION, and (2) submit updated package to CRAN (previous CRAN maintainer will have to confirm change by email to CRAN).
72
+
* How to obtain this role: (1) merge into master a PR adding role="cre" to DESCRIPTION, and (2) submit updated package to CRAN (previous CRAN Maintainer will have to confirm change by email to CRAN).
73
73
* How this role is recognized: credited via role="cre" in DESCRIPTION, so they appear as Maintainer on CRAN.
74
74
75
75
# Decision-making processes
@@ -80,17 +80,17 @@ Most decisions in the project happen by Consensus, which means that no active pe
80
80
81
81
## Pull Requests
82
82
83
-
A pull request can be merged by any committer, if there is one approving review, and Consensus from active Reviewers and Committers.
83
+
A pull request can be merged by any Committer, if there is one approving review, and Consensus from active Reviewers and Committers.
84
84
* approving review must come from someone other than the author of the PR.
85
-
* approving review ideally comes from a reviewer of the affected files.
86
-
* approving review can and often will be by the committer who merges the PR.
85
+
* approving review ideally comes from a Reviewer of the affected files.
86
+
* approving review can and often will be by the Committer who merges the PR.
87
87
88
88
## CRAN updates
89
89
90
90
* Regular CRAN releases should ideally occur twice per year, and can include new features.
91
-
* A hotfix/patch CRAN release should occur when CRAN asks for one, at which time the CRAN maintainer should post an issue on github, and ask others to help fix/prepare the release. It should not include new features.
91
+
* A hotfix/patch CRAN release should occur when CRAN asks for one, at which time the CRAN Maintainer should post an issue on github, and ask others to help fix/prepare the release. It should not include new features.
92
92
* Both kinds of releases should be discussed in an issue, and the release should happen only if there is Consensus among active Reviewers and Committers.
93
-
* It is the responsibility of the CRAN maintainer to ensure quality prior to release. This includes CRAN checks, unit tests, performance tests, etc, and these tasks can be delegated to others.
93
+
* It is the responsibility of the CRAN Maintainer to ensure quality prior to release. This includes CRAN checks, unit tests, performance tests, etc, and these tasks can be delegated to others.
94
94
95
95
## Changing this GOVERNANCE.md document
96
96
@@ -124,7 +124,7 @@ data.table Version line in DESCRIPTION typically has the following meanings
124
124
125
125
# Governance history
126
126
127
-
Jan 2025: clarify that edits to governance should notify all committers.
127
+
Jan 2025: clarify that edits to governance should notify all committers, and that role names are proper nouns (i.e., upper-case) throughout.
128
128
129
129
Feb 2024: change team name/link maintainers to committers, to be consistent with role defined in governance.
0 commit comments