Skip to content

Commit 906cf9a

Browse files
committed
readme
1 parent 94a53c3 commit 906cf9a

File tree

1 file changed

+25
-33
lines changed

1 file changed

+25
-33
lines changed

README.md

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# lambdaisland/kaocha-junit-xml
22

33
<!-- badges -->
4-
[![CircleCI](https://circleci.com/gh/lambdaisland/kaocha-junit-xml.svg?style=svg)](https://circleci.com/gh/lambdaisland/kaocha-junit-xml) [![cljdoc badge](https://cljdoc.org/badge/lambdaisland/kaocha-junit-xml)](https://cljdoc.org/d/lambdaisland/kaocha-junit-xml) [![Clojars Project](https://img.shields.io/clojars/v/lambdaisland/kaocha-junit-xml.svg)](https://clojars.org/lambdaisland/kaocha-junit-xml)
4+
[![GitHub Actions](https://github.com/lambdaisland/kaocha-junit-xml/actions/workflows/main.yml/badge.svg)] [![cljdoc badge](https://cljdoc.org/badge/lambdaisland/kaocha-junit-xml)](https://cljdoc.org/d/lambdaisland/kaocha-junit-xml) [![Clojars Project](https://img.shields.io/clojars/v/lambdaisland/kaocha-junit-xml.svg)](https://clojars.org/lambdaisland/kaocha-junit-xml)
55
<!-- /badges -->
66

77
[Kaocha](https://github.com/lambdaisland/kaocha) plugin to generate a JUnit XML version of the test results.
88

99
<!-- opencollective -->
10-
11-
## Support Lambda Island Open Source
10+
## Lambda Island Open Source
1211

1312
Thank you! kaocha-junit-xml is made possible thanks to our generous backers. [Become a
1413
backer on OpenCollective](https://opencollective.com/lambda-island) so that we
@@ -22,20 +21,17 @@ can continue to make kaocha-junit-xml better.
2221

2322
&nbsp;
2423

25-
kaocha-junit-xml is part of a growing collection of quality Clojure libraries and
26-
tools released on the Lambda Island label. If you are using this project
27-
commercially then you are expected to pay it forward by
28-
[becoming a backer on Open Collective](http://opencollective.com/lambda-island#section-contribute),
29-
so that we may continue to enjoy a thriving Clojure ecosystem.
24+
kaocha-junit-xml is part of a growing collection of quality Clojure libraries created and maintained
25+
by the fine folks at [Gaiwan](https://gaiwan.co).
3026

31-
&nbsp;
27+
Pay it forward by [becoming a backer on our OpenCollective](http://opencollective.com/lambda-island),
28+
so that we continue to enjoy a thriving Clojure ecosystem.
3229

33-
&nbsp;
30+
You can find an overview of all our different projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source).
3431

3532
&nbsp;
3633

3734
&nbsp;
38-
3935
<!-- /opencollective -->
4036

4137
## Usage
@@ -206,39 +202,35 @@ Notably, CircleCI's [parallelization](https://circleci.com/docs/use-the-circleci
206202
<!-- contributing -->
207203
## Contributing
208204

209-
Everyone has a right to submit patches to kaocha-junit-xml, and thus become a contributor.
210-
211-
Contributors MUST
205+
We warmly welcome patches to kaocha-junit-xml. Please keep in mind the following:
212206

213207
- adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide)
214-
- write patches that solve a problem. Start by stating the problem, then supply a minimal solution. `*`
215-
- agree to license their contributions as EPL 1.0.
216-
- not break the contract with downstream consumers. `**`
217-
- not break the tests.
208+
- write patches that solve a problem
209+
- start by stating the problem, then supply a minimal solution `*`
210+
- by contributing you agree to license your contributions as EPL 1.0
211+
- don't break the contract with downstream consumers `**`
212+
- don't break the tests
218213

219-
Contributors SHOULD
214+
We would very much appreciate it if you also
220215

221-
- update the CHANGELOG and README.
222-
- add tests for new functionality.
216+
- update the CHANGELOG and README
217+
- add tests for new functionality
223218

224-
If you submit a pull request that adheres to these rules, then it will almost
225-
certainly be merged immediately. However some things may require more
226-
consideration. If you add new dependencies, or significantly increase the API
227-
surface, then we need to decide if these changes are in line with the project's
228-
goals. In this case you can start by [writing a pitch](https://nextjournal.com/lambdaisland/pitch-template),
229-
and collecting feedback on it.
219+
We recommend opening an issue first, before opening a pull request. That way we
220+
can make sure we agree what the problem is, and discuss how best to solve it.
221+
This is especially true if you add new dependencies, or significantly increase
222+
the API surface. In cases like these we need to decide if these changes are in
223+
line with the project's goals.
230224

231-
`*` This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution.
225+
`*` This goes for features too, a feature needs to solve a problem. State the problem it solves first, only then move on to solving it.
232226

233-
`**` As long as this project has not seen a public release (i.e. is not on Clojars)
234-
we may still consider making breaking changes, if there is consensus that the
235-
changes are justified.
227+
`**` Projects that have a version that starts with `0.` may still see breaking changes, although we also consider the level of community adoption. The more widespread a project is, the less likely we're willing to introduce breakage. See [LambdaIsland-flavored Versioning](https://github.com/lambdaisland/open-source#lambdaisland-flavored-versioning) for more info.
236228
<!-- /contributing -->
237229

238230
<!-- license -->
239231
## License
240232

241-
Copyright &copy; 2018-2020 Arne Brasseur and contributors
233+
Copyright &copy; 2018-2025 Arne Brasseur and contributors
242234

243235
Available under the terms of the Eclipse Public License 1.0, see LICENSE.txt
244-
<!-- /license -->
236+
<!-- /license -->

0 commit comments

Comments
 (0)