Skip to content

Commit f6bb955

Browse files
readme: add back contributing section, for #827 (#831)
* readme: add back contributing section, for #827 * readme: remove retired goreportcard
1 parent 1b3ab2e commit f6bb955

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@
1616
<a href="https://codecov.io/gh/gabriel-vasile/mimetype">
1717
<img alt="Code coverage" src="https://codecov.io/gh/gabriel-vasile/mimetype/graph/badge.svg">
1818
</a>
19-
<a href="https://goreportcard.com/report/github.com/gabriel-vasile/mimetype">
20-
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/gabriel-vasile/mimetype">
21-
</a>
2219
<a href="LICENSE">
2320
<img alt="License" src="https://img.shields.io/badge/License-MIT-green.svg">
2421
</a>
@@ -106,3 +103,10 @@ shows which file formats are most often misidentified and can help prioritise.
106103
When submitting a PR for detection of a new file format, please make sure to
107104
add a record to the list of testcases in [mimetype_test.go](mimetype_test.go).
108105
For complex files a record can be added in the [testdata](testdata) directory.
106+
Code contributions must respect following rules:
107+
- code must be test covered
108+
- code must be formatted using the `gofmt` tool
109+
- exported names must be documented
110+
111+
**Important**: By submitting a pull request, you agree to allow the project
112+
owner to license your work under the same license as that used by the project.

0 commit comments

Comments
 (0)