Reorganize contributor license docs #74
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| #### When the Repo Includes the CLA | ||
|
|
||
| If the `CONTRIBUTING.md` document says you need to sign the CLA, for example: |
There was a problem hiding this comment.
I think the wording here is too narrowly scoped. What if the repo doesn't "say that you need to sign a CLA" but says something like "CLA is required"?
There was a problem hiding this comment.
do you have a suggestion for how to fix it? I don't say the language on the CONTRIBUTING is exactly "you need to sign", and I assume people can translate a CONTRIB that says "you are required to" to the "you need to" language here - but maybe I'm misunderstanding? 😬
There was a problem hiding this comment.
from a legal perspective, it may open things up to intentional unwanted avoidance of the CLA. Maybe we should say something like:
If the `CONTRIBUTING.md` document indicates that you need to sign the CLA, for example:
CONTRIBUTING.md
Outdated
| > our Contributor Agreement. This provides patent protection for all Conjur users and allows | ||
| > CyberArk to enforce its license terms. Please email a signed copy to oss@cyberark.com." | ||
| Then you **must** submit a signed copy of the CLA to oss@cyberark.com in order |
CONTRIBUTING.md
Outdated
|
|
||
| To sign-off, use: | ||
|
|
||
| git commit --signoff |
There was a problem hiding this comment.
We should use the escape ticks instead of indents for code snippets. Same comment for code right below.
CONTRIBUTING.md
Outdated
|
|
||
| git commit --amend -s | ||
|
|
||
| After amending a commit, you will need to force-push (`push -f`) to your branch for this to take |
There was a problem hiding this comment.
| After amending a commit, you will need to force-push (`push -f`) to your branch for this to take | |
| After amending a commit, you will need to force-push (`git push -f <branch_name>`) to your branch for this to take |
CONTRIBUTING.md
Outdated
| effect. | ||
|
|
||
| > Note: Only repositories licensed under MIT, BSD, or Apache 2.0 are eligible to use the DCO instead | ||
| of the CLA for community contributions!!** If the repo does not meet this criteria, you **must** |
There was a problem hiding this comment.
I think this Note: doesn't have a matching number of **s
CONTRIBUTING.md
Outdated
| To determine if you **have** signed a commit, look at the commit history in the branch to ensure | ||
| each commit includes a line like: | ||
|
|
||
| Signed-off-by: Random J Developer <random@developer.example.org> |
There was a problem hiding this comment.
Random in some contexts can be construed as derogatory
| Signed-off-by: Random J Developer <random@developer.example.org> | |
| Signed-off-by: Jane A Doe <jane@developer.example.org> |
Conjur/CONTRIBUTING.md
Outdated
| [when the repo includes the CLA](../CONTRIBUTING.md#when-the-repo-includes-the-cla). | ||
|
|
||
| If the CONTRIBUTING file _does not_ ask you to sign the CLA, follow the instructions | ||
| for [when the repo does not include the CLA](../CONTRIBUTING.md#when-the-repo-does-not-include-the-cla). These instructions will also walk you through how to add a signoff to |
Move general docs from Conjur CONTRIBUTING to general CONTRIBUTING, so that it's more visible early on. Retain links in Conjur CONTRIBUTING as we do with other "dev how to" sections.
izgeri
force-pushed
the
reorganize-contrib-license-docs
branch
from
82e89bd to
cac2f91
Compare
Move general docs from Conjur CONTRIBUTING to general CONTRIBUTING, so that
it's more visible early on.
Retain links in Conjur CONTRIBUTING as we do with other "dev how to" sections.