Skip to content

Commit 54fd61c

Browse files
committed
Update the README
1 parent b9fbc09 commit 54fd61c

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

README.md

+54-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,26 @@
66

77
Kaocha plugin to get code coverage reports through [Cloverage](https://github.com/cloverage/cloverage).
88

9+
<!-- opencollective -->
10+
### Support Lambda Island Open Source
11+
12+
If you find value in our work please consider [becoming a backer on Open Collective](http://opencollective.com/lambda-island#section-contribute)
13+
<!-- /opencollective -->
14+
15+
## Installation
16+
17+
deps.edn
18+
19+
```
20+
lambdaisland/kaocha-cloverage {:mvn/version "1.0-45"}
21+
```
22+
23+
project.clj
24+
25+
```
26+
[lambdaisland/kaocha-cloverage "1.0-45"]
27+
```
28+
929
## Usage
1030

1131
Add the dependency
@@ -61,10 +81,43 @@ Alternatively Cloverage can be configured through `tests.edn`. Source paths spec
6181
:codecov? false}}
6282
```
6383

84+
<!-- contributing -->
85+
### Contributing
86+
87+
Everyone has a right to submit patches to this projects, and thus become a contributor.
88+
89+
Contributors MUST
90+
91+
- adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide)
92+
- write patches that solve a problem. Start by stating the problem, then supply a minimal solution. `*`
93+
- agree to license their contributions as MPLv2.
94+
- not break the contract with downstream consumers. `**`
95+
- not break the tests.
96+
97+
Contributors SHOULD
98+
99+
- update the CHANGELOG and README.
100+
- add tests for new functionality.
101+
102+
If you submit a pull request that adheres to these rules, then it will almost
103+
certainly be merged immediately. However some things may require more
104+
consideration. If you add new dependencies, or significantly increase the API
105+
surface, then we need to decide if these changes are in line with the project's
106+
goals. In this case you can start by [writing a
107+
pitch](https://nextjournal.com/lambdaisland/pitch-template), and collecting
108+
feedback on it.
109+
110+
`*` This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution.
111+
112+
`**` As long as this project has not seen a public release (i.e. is not on Clojars)
113+
we may still consider making breaking changes, if there is consensus that the
114+
changes are justified.
115+
<!-- /contributing -->
116+
64117
<!-- license-epl -->
65118
## License
66119
&nbsp;
67-
Copyright &copy; 2018-2019 Arne Brasseur
120+
Copyright &copy; 2018-2020 Arne Brasseur and Contributors
68121
&nbsp;
69122
Available under the terms of the Eclipse Public License 1.0, see LICENSE.txt
70123
<!-- /license-epl -->

0 commit comments

Comments
 (0)