New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add CONTRIBUTING.md #397
Add CONTRIBUTING.md #397
Conversation
This adds a new CONTRIBUTING.md, outlining the steps for the new DCO policy along with some info on the image publishing workflow. Signed-off-by: Tim Buckley <timothy.jas.buckley@hpe.com>
Hi all, would appreciate some feedback on this. I imagine there's plenty of stuff missing, but hopefully this is a decent start. I'm hoping to follow up with a CI check for 'signed-off-by' soon as well. |
CC @cheld |
Added to agenda for today's team meeting. |
Readings about DCO vs CLA: DCO in Chef: Seems to be ok. At least short-term. In long term maybe CCLA required/requested. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small error.
Document as a whole looks fine for me (I'm not lawyer).
One question: do we also need to store Developer Certificate of Origin
in separate file or it's fine if it's only in CONTRIBUTING.md?
CONTRIBUTING.md
Outdated
|
||
Several components are not given explicit versions as they track upstream Git | ||
repositories, so tags are generated automatically at build time. As these | ||
automatic |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rest of the sentence got eaten
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch, I'll make sure to fix it. Thanks!
Will this guide (in particular DCO) apply to all repositories or just monasca-docker? |
@matrixik from the examples I've seen (our legal department pointed us to https://github.com/moby/moby/blob/master/CONTRIBUTING.md), copying/linking to http://developercertificate.org in @witekest it will apply to any repositories created by HPE employees, I'm planning to start copying it over to monasca-helm and others once we're happy with this patch. I think it's up to you and your team if you want to apply it to https://github.com/monasca/monasca-agents-installer or any other repos you create |
|
||
The procedure for releasing looks like this: | ||
|
||
1. Merge any desired upstream changes to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not fond of all this steps but good it's documented now.
|
||
### Signing Commits | ||
|
||
We require a code sign-off for all contributions to indicate you have the right |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would just copy the text from Docker:
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've quoted that section in the guide. Thanks for the suggestion!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, looks good to me.
This adds a new CONTRIBUTING.md, outlining the steps for the new DCO
policy along with some info on the image publishing workflow.
Signed-off-by: Tim Buckley timothy.jas.buckley@hpe.com