Skip to content

doc: clarified & split up contribution docs

Rodrigo Muino Tomonari requested to merge github/fork/rvagg/contributing into v1.x

This is kind of large and contains cleanup, additions and some minor changes to policy so it'll need to be TC approved.

Added two extra docs in root: GOVERNANCE.md and COLLABORATOR_GUIDE.md, edited README.md and CONTRIBUTING.md

  • Properly introduced Collaborators as a group, distinct from the TC but from which the TC is a subset, this can be seen across all of the docs in this PR
  • Clarified the roles and responsibilities of the Collaborators and introduced a COLLABORATOR_GUIDE.md that includes the guides on closing PRs and Issues as discussed in the 2014-12-17 meeting (#178). I've also moved the whole HOWTO documentation that @indutny contributed into this document and out of CONTRIBUTING.md
  • Split out GOVERNANCE.md, it was in CONTRIBUTING.md
  • Cleaned up GOVERNANCE.md with additions
    • a section on Collaborators so they are now a distinct part of governance
    • the list of TC members is moved to the README (see below), so it's only maintained in one place and is with the Collaborators
    • "The TC may add contributors to the TC by unanimous consensus." (was just "additional members")
    • "a designated moderator approved by the TC" (less specific)
    • re TC meetings: "The intention of the agenda is not to approve or review all patches, that should happen continuously on GitHub and be handled by the larger group of Collaborators." (introduced Collaborators here)
    • "Any Collaborator, TC member or the moderator can add the item to the agenda by adding the _tc-agenda_ tag to the issue." (was just "TC member or the moderator" and was a "+1", now any Collaborator can do it and it's a label)
    • "the moderator will share the Agenda with members of the TC" (was email)
    • and some other very minor things, you can diff this new file against the current CONTRIBUTING.md to see the differences but please read the full thing because it relates to policy.
  • Added the team member list to the README. When adding people to the project we should make it a big deal for them and also give a clear list of people for outsiders to bother to get attention for their pet-issues
  • While I was in the README I removed a bunch of cruft, including lots of the resources that point to joyent/node, most of them are out of date anyway. We can put some stuff back (like "installing") when we have a release and concrete actions to recommend to people. I also did a cleanup of some of the install docs.

I don't really know what to do with the section in CONTRIBUTING.md on Caine yet, is he active? Does he need such a large mention (it's kind of confusing as it is)?

Further to this I'll be enumerating people who have made "significant" contributions to the project for consideration at the next TC meeting in #230 (closed) because that hasn't been properly done yet!

Merge request reports