add CONTRIBUTING.md for all of CHAOSS #5
Conversation
|
|
||
| ## What is this document? | ||
|
|
||
| This document outlines a generic process of contributing and applies to all CHAOSS repositories. Each repository may have unique guidelines specific to the project. |
There was a problem hiding this comment.
So it's a good thing to have a CONTRIBUTING.md file at the root of every repo for the reasons outlined on GitHub's annoucement post.
There was a problem hiding this comment.
Agreed. My thought was to leave repository specific elements in those files and move common elements in this CONTRIBUTING.md and link to it. --- We don't need to explain how to use git and forks on every repository.
There was a problem hiding this comment.
We don't need to explain how to use git and forks on every repository.
You could even link to some external documentation for that, fwiw.
There was a problem hiding this comment.
Linking to resources is what I tried to do below. Suggestions for additional resources?
CONTRIBUTING.md
Outdated
| At this point you are waiting on us. We will comment on your pull requests | ||
| within three business days (and, typically, one business day). | ||
|
|
||
| The CHAOSS maintainers will report on open issues and pull requests on the calls and via the mail list to elicit feedback from the community. |
There was a problem hiding this comment.
Same here: "CHAOSS maintainers" is probably not the right term. I suppose it's the maintainers for this repository you're talking about, here. Which brings me to think it would be good to have a process to describe how you become an maintainer, and what are your rights and responsibilities when you do.
There was a problem hiding this comment.
@tobie thanks for this. Perhaps this could be modified to Specific CHAOSS Repository Maintainers.
@GeorgLink, perhaps we should put 'path to maintainership' on the to-do list for the Metrics committee.
There was a problem hiding this comment.
great idea, I opened an issue for 'path to maintainership': chaoss/metrics#56
CONTRIBUTING.md
Outdated
| [pr]: https://github.com/thoughtbot/factory_girl_rails/compare/ | ||
| [clone]: https://help.github.com/articles/cloning-a-repository/ | ||
|
|
||
| At this point you are waiting on us. We will comment on your pull requests |
There was a problem hiding this comment.
You want to define who is "us" more precisely here. Is there an editor per repo? A team of maintainers? What process to they use to merge stuff, etc.
There was a problem hiding this comment.
Again, perhaps: Specific CHAOSS Repository Maintainers
CONTRIBUTING.md
Outdated
| The CHAOSS maintainers will report on open issues and pull requests on the calls and via the mail list to elicit feedback from the community. | ||
|
|
||
| ## What about releases? | ||
| CHAOSS tags commits on the master branch as [releases][rl] (snapshots). Each project has its own release cadence. Between releases, the master branch is under development. |
There was a problem hiding this comment.
Who's responsible for the release schedule? Maintainers? The committee?
There was a problem hiding this comment.
I think that this is up to maintainers. We haven't formed committees for the specific tools. To be honest, on the Metrics side of things, this has been more of a fuzzy consensus that we've talked through at the weekly/monthly meetings.
There was a problem hiding this comment.
This is related to specifying who is a maintainer. They are the ones who have to do the release and oversee the process.
|
@tobie @germonprez please take a look at the last commit. I specified that the 'CHAOSS repository maintainers' are the actors. I also added that each repository shall specify
|
CONTRIBUTING.md
Outdated
| within three business days (and, typically, one business day). | ||
|
|
||
| The CHAOSS maintainers will report on open issues and pull requests on the calls and via the mail list to elicit feedback from the community. | ||
| The CHAOSS repository maintainers will report on open issues and pull requests on the calls and via the mail list to elicit feedback from the community. |
There was a problem hiding this comment.
I added a link as suggested. Thanks @tobie
|
LGTM |
|
|
||
| ## What is this document? | ||
|
|
||
| This document outlines a generic process of contributing and applies to all CHAOSS repositories. Each repository may have unique guidelines specific to the project. |
There was a problem hiding this comment.
Linking to resources is what I tried to do below. Suggestions for additional resources?
|
Achieved lazy consensus --> merging. |
|
all repository contributing.md files should link to this. |
The idea is to centralize the repeating explanations of how to contribute to CHAOSS and using GitHub.
Each project repository can describe in their README.md unique differences, such as required tools for software development or how a repository is structured.