Update documentation to meet CII badging requirements #2792
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| 1. If you're adding a new graphical feature, please add a short example | ||
| to the appropriate function. | ||
|
|
||
| This seems like a lot of work but don't worry if your pull request isn't perfect. It's a learning process and Winston and I will be on hand to help you out. A pull request is a process, and unless you've submitted a few in the past it's unlikely that your pull request will be accepted as is. | ||
| This seems like a lot of work but don't worry if your pull request isn't perfect. | ||
| It's a learning process and Winston and I will be on hand to help you out. |
There was a problem hiding this comment.
Maybe replace "Winston and I" by "members of the ggplot2 team"?
There was a problem hiding this comment.
good call. will do.
|
Can you propose something for the "document governance model" and "document roles and responsibilities"? I'd suggest something that references the tidyverse ggplot2 (which, unfortunately, as far as I can tell, is not publicly listed on github), and mention some sort of consensus model where I step in a benevolent dictator to resolve any conflicts. You can now also mention that all PRs require review from at least one core member. |
|
Alright, you'll see I've drafted up a governance doc including roles and responsibilities. I started with the Benevolent dictator governance model by Ross |
There was a problem hiding this comment.
Looks like a great start.
@jennybc and @batpigandme can you take a look too please?
GOVERNANCE.md
Outdated
| The job of the benevolent dictator is to set the strategic objectives of the project and communicate these clearly to the community, ensuring that the project survives in the long term. | ||
|
|
||
| ## [Core Developers](https://github.com/orgs/tidyverse/teams/ggplot2) | ||
| Core developers are contributors who have made several valuable contributions to the project and are now relied upon to both write code directly to the repository and screen the contributions of others. Committers have no authority over the overall direction of the project, however it is their job to help develop or elicit appropriate contributions to the project. Many core developers are also [package authors](https://ggplot2.tidyverse.org/authors.html). |
There was a problem hiding this comment.
I think as a matter of policy, all core developers (even if no longer active) should be included in authors.
There was a problem hiding this comment.
And maybe mention that they're empowered to merge PRs (after review)?
GOVERNANCE.md
Outdated
| Contributors are community members who make valuable contributions, such as those outlined in the list below, but generally do not have the authority to make direct changes to the project code. Contributors most often engage with the project | ||
| as outlined in the project's [CONTRIBUTING](https://github.com/tidyverse/ggplot2/blob/master/CONTRIBUTING.md) document. | ||
|
|
||
| Anyone can become a contributor. There is no expectation of commitment to the project, no specific skill requirements and no selection process. To become a contributor, a community member simply has to perform one or more actions that are beneficial to the project. |
|
This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/ |
This PR should be considered a WIP and a place for discussion as we decide whether or not to pursue silver and gold badging from CII.
This first commit adds a code of conduct (
usethis::use_tidy_coc) and makes explicit the policy of adding tests for each new feature in our CONTRIBUTING.mdNext documentation updates to achieve silver would be:
could be as simple as "Project owner makes all final decisions"
maintainer/author/contributor designation on description could possibly suffice, if we added/linked to definition of those roles somewhere.
"what the user can and cannot expect in terms of security from the software produced"
gold requires
among other things related to security or testing practices. This PR only relates to the necessary documentation changes. See the boiled down list of remaining requirements for ggplot2 at #2700, which also contains a link to the full badging checklist.
If it is determined that we should not pursue beyond a passing badge, this PR can be closed, or merged as is, given the updates to contributing.md and the additional of a COC are probably desirable in their own right.
It's perhaps worth noting there is still at least one hurdle keeping us from a passing badge and which is a requirement for any higher level badge. Read more at #2700