This repository was archived by the owner on Sep 11, 2020. It is now read-only.
License upgrade, plus code of conduct and contributing guidelines #680
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
orirawlings
suggested changes
Dec 6, 2017
CODE_OF_CONDUCT.md
Outdated
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [INSERT EMAIL ADDRESS]. All |
There was a problem hiding this comment.
We should fix the placeholder contact information here.
There was a problem hiding this comment.
probably worth creating [email protected]?
CONTRIBUTING.md
Outdated
| @@ -0,0 +1,61 @@ | |||
| # Contributing Guidelines | |||
|
|
|||
| source{d} go-git project is [Apache 2.0 licensed](LICENSE) and accept | |||
campoy
reviewed
Dec 6, 2017
| ## Certificate of Origin | ||
|
|
||
| By contributing to this project you agree to the [Developer Certificate of | ||
| Origin (DCO)](DCO). This document was created by the Linux Kernel community and is a |
campoy
suggested changes
Dec 6, 2017
CONTRIBUTING.md
Outdated
|
|
||
| This can be done easily using the [`-s`](https://github.com/git/git/blob/b2c150d3aa82f6583b9aadfecc5f8fa1c74aca09/Documentation/git-commit.txt#L154-L161) flag on the `git commit`. | ||
|
|
||
|
|
CONTRIBUTING.md
Outdated
| - All PRs must be written in idiomatic Go, formatted according to [gofmt](https://golang.org/cmd/gofmt/), and without any warnings from [go lint](https://github.com/golang/lint) nor [go vet](https://golang.org/cmd/vet/). | ||
| They should in general include tests, and those shall pass. | ||
| - If the PR is a bug fix, it has to include a new unit test that fails before the patch is merged. | ||
| - If the PR is a new feature, it has to come with a suite of unit tests, that tests the new functionality. |
There was a problem hiding this comment.
"a suite of unit tests for the new functionality."
CONTRIBUTING.md
Outdated
| They should in general include tests, and those shall pass. | ||
| - If the PR is a bug fix, it has to include a new unit test that fails before the patch is merged. | ||
| - If the PR is a new feature, it has to come with a suite of unit tests, that tests the new functionality. | ||
| - In any case, all the PRs have to pass the personal evaluation of at least one of the [maintainers](MAINTAINERS) of go-git. |
| Every commit message should describe what was changed, under which context and, if applicable, the GitHub issue it relates to: | ||
|
|
||
| ``` | ||
| plumbing: packp, Skip argument validations for unknown capabilities. Fixes #623 |
There was a problem hiding this comment.
does the Fixes #623 need to be part of the issue title?
There was a problem hiding this comment.
@campoy do you mean "PR title"?
There was a problem hiding this comment.
yes, basically: does it need to be all in one line? or can it be:
repo: package, change something important
More detailed description of what was changed and why.
Fixes #1234
There was a problem hiding this comment.
Yeah, might be a good time to start encouraging more detailed, multi-line commit messages like what you are proposing @campoy
There was a problem hiding this comment.
I rather having only the subject, and the long description if need it, in the PR, otherwise is duplicated.
Signed-off-by: Máximo Cuadros <[email protected]>
Signed-off-by: Máximo Cuadros <[email protected]>
Signed-off-by: Máximo Cuadros <[email protected]>
Signed-off-by: Máximo Cuadros <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.