Skip to content

Commit 309d236

Browse files
authored
engineering: applying review cooments to CONTRIBUTING.md
1 parent a1b8c9c commit 309d236

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

engineering/documents/CONTRIBUTING.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,46 @@
22

33
source{d} go-git project is [Apache 2.0 licensed](LICENSE) and accept
44
contributions via GitHub pull requests. This document outlines some of the
5-
conventions on development workflow, commit message formatting, contact points
5+
conventions on development workflow, commit message formatting, contact points,
66
and other resources to make it easier to get your contribution accepted.
77

88
## Certificate of Origin
99

10-
By contributing to this project you agree to the Developer Certificate of
11-
Origin (DCO). This document was created by the Linux Kernel community and is a
10+
By contributing to this project you agree to the [Developer Certificate of
11+
Origin (DCO)](DCO). This document was created by the Linux Kernel community and is a
1212
simple statement that you, as a contributor, have the legal right to make the
13-
contribution. See the [DCO](DCO) file for details.
13+
contribution.
1414

1515
## Support Channels
1616

17-
Whether you are a user or contributor, official support channels include:
17+
The official support channels, for both users and contributors, are:
1818

19-
- GitHub [issues](https://github.com/src-d/go-git/issues/new)
20-
- Slack: #go-git room in the [source{d} Slack](http://sourced.tech/)
19+
- GitHub [issues](https://github.com/src-d/go-git/issues)*
20+
- Slack: #go-git room in the [source{d} Slack](https://join.slack.com/t/sourced-community/shared_invite/enQtMjc4Njk5MzEyNzM2LTFjNzY4NjEwZGEwMzRiNTM4MzRlMzQ4MmIzZjkwZmZlM2NjODUxZmJjNDI1OTcxNDAyMmZlNmFjODZlNTg0YWM)
2121

22-
Before opening a new issue or submitting a new pull request, it's helpful to
22+
*Before opening a new issue or submitting a new pull request, it's helpful to
2323
search the project - it's likely that another user has already reported the
2424
issue you're facing, or it's a known issue that we're already aware of.
2525

2626

2727
## How to Contribute
2828

29-
PRs are the main and exclusive way to contribute to the official go-git project.
29+
Pull Requests (PRs) are the main and exclusive way to contribute to the official go-git project.
3030
In order for a PR to be accepted it needs to pass a list of requirements:
3131

3232
- You should be able to run the same query using `git`. We don't accept features that are not implemented in the official git implementation.
33-
- The expected behavior must match the official git implementation.
33+
- The expected behavior must match the [official git implementation](https://github.com/git/git).
3434
- The actual behavior must be correctly explained with natural language and providing a minimum working example in Go that reproduces it.
35-
- In case a PR is submitted, it has to be written in idiomatic Go, formatted properly using gofmt, that compiles without warning and passes all the current tests.
35+
- 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/).
36+
They should in general include tests, and those shall pass.
3637
- If the PR is a bug fix, it has to include a new unit test that fails before the patch is merged.
3738
- If the PR is a new feature, it has to come with a suite of unit tests, that tests the new functionality.
38-
- In any case, all the PRs have to pass the personal evaluation of at least one of the maintainers of go-git.
39+
- In any case, all the PRs have to pass the personal evaluation of at least one of the [maintainers](MAINTAINERS) of go-git.
3940

4041

4142
### Format of the commit message
4243

43-
Every commit message should describe what changed, in which context:
44+
Every commit message should describe what was changed, under which context and, if applicable, the GitHub issue it relates to:
4445

4546
```
4647
plumbing: packp, Skip argument validations for unknown capabilities. Fixes #623

0 commit comments

Comments
 (0)