Skip to content

Commit 3079505

Browse files
authored
Contribution instructions (#30)
1 parent 8660fd5 commit 3079505

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ go get -u github.com/joshdk/go-junit
1919

2020
### Data Ingestion
2121

22-
This library has a number of ingestion methods for convenient.
22+
This library has a number of ingestion methods for convenience.
2323

2424
The simplest of which parses raw JUnit XML data.
2525

@@ -155,6 +155,16 @@ In all cases, omitting (or even duplicated) the XML declaration tag is allowed.
155155
<?xml version="1.0" encoding="UTF-8"?>
156156
```
157157

158+
## Contributing
159+
160+
Found a bug or want to make go-junit better? Please [open a pull request](https://github.com/joshdk/go-junit/compare)!
161+
162+
To make things easier, try out the following:
163+
164+
- Running `make test` will run the test suite to verify behavior.
165+
166+
- Running `make lint` will format the code, and report any linting issues using [golangci/golangci-lint](https://github.com/golangci/golangci-lint).
167+
158168
## License
159169

160170
This code is distributed under the [MIT License][license-link], see [LICENSE.txt][license-file] for more information.

0 commit comments

Comments
 (0)