1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
# Contributing Guidelines
go-license-detector project is [Apache licensed](LICENSE.md) and accepts
contributions via GitHub pull requests. This document outlines some of the
conventions on development workflow, commit message formatting, contact points,
and other resources to make it easier to get your contribution accepted.
## Support Channels
The official support channels, for both users and contributors, are:
- GitHub [issues](https://github.com/go-enry/go-license-detector/issues)*
*Before opening a new issue or submitting a new pull request, it's helpful to
search the project - it's likely that another user has already reported the
issue you're facing, or it's a known issue that we're already aware of.
## How to Contribute
Pull Requests (PRs) are the main and exclusive way to contribute to the official go-license-detector project.
In order for a PR to be accepted it needs to pass a list of requirements:
- All PRs must be written in idiomatic Go, formatted according to [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), and without any warnings from [go lint](https://github.com/golang/lint) nor [go vet](https://golang.org/cmd/vet/).
- New features should be generally covered with tests.
- The test suite must pass.
- All PRs have to pass the personal evaluation of at least one of the [maintainers](MAINTAINERS.md).
### Format of the commit message
The commit summary must start with a capital letter and with a verb in present tense. No dot in the end.
```
Add a feature
Remove unused code
Fix a bug
```
Every commit details should describe what was changed, under which context and, if applicable, the GitHub issue it relates to.
|
