Update contributing guidelines and add maintainer guidelines #56
Conversation
Each project in the OCI should have similar contributing guidelines and maintainer guidelines. Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
|
|
||
| We are always thrilled to receive pull requests, and do our best to | ||
| process them as fast as possible. Not sure if that typo is worth a pull | ||
| request? Do it! We will appreciate it. |
There was a problem hiding this comment.
My initial CONTRIBUTING.md submission in #43 assumed this project was following the runtime-spec's [“one sentence per line”][1] convention. Is this new content copy/pasted from somewhere else? Should it be updated here (or upstream?) to match that convention?
There was a problem hiding this comment.
The goal is for all OCI projects to share the same files, we have created a repo here:
https://github.com/opencontainers/project-template
There was a problem hiding this comment.
On Tue, May 03, 2016 at 11:59:17AM -0700, Chris Aniszczyk wrote:
The goal is for all OCI projects to share the same files, we have created a repo here:
https://github.com/opencontainers/project-template
Sounds like a reasonable starting point, but this CONTRIBUTING.md is
currently too specific to apply to this repo (e.g. references to a
test suite we don't have). Are downstream modifications like removing
test references or the leader-issue requirement allowed? Does the
upstream project-template follow runtime-spec's “one sentence per
line”? Should I be discussing this in
opencontainers/project-template#1?
|
@mrunalp can you restart the build? we got a weird error |
| a pull request removing them. | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
One trailing newline is probably enough ;).
|
I have hit restart. |
|
@wking there files should be general in scope so that all OCI projects can share the same structure and files for how the projects are run. Alot of your comments are on specific points regarding how they related to this project but should be general applicable for everything. |
|
On Tue, May 03, 2016 at 01:44:10PM -0700, Michael Crosby wrote:
I agree that it's nice to share generic docs. But I don't think it
Both of those changes sound useful to me, but I'm not sure what sounds |
|
I think it would be better to just move this conversation to the repo from my comment here: opencontainers/runtime-spec#420 (comment) We can work out the kinks and get this in shape so that it can apply to all of OCI's repos. |
|
@crosbymichael Sounds good. The build failure seems related to travis not populating the commit range so we can merge this now. |
|
LGTM |
|
@mrunalp i was more meaning that we can close this for now but we can made the changes and have another pr to update this. both work fine |
|
@crosbymichael I misread your comment and have merged this but we can fix this depending on what we decide. Leaving it in for now. |
|
works for me, thanks ;) |
|
Cool :) |
Each project in the OCI should have similar contributing guidelines
and maintainer guidelines.
Signed-off-by: Chris Aniszczyk caniszczyk@gmail.com