Skip to content

Commit 2bfcfe4

Browse files
committed
Update README
1 parent d8b2057 commit 2bfcfe4

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -264,17 +264,25 @@ When not using `*debug*` you can still set these log levels separately through
264264
<!-- opencollective -->
265265
## Lambda Island Open Source
266266

267+
Thank you! kaocha-cljs is made possible thanks to our generous backers. [Become a
268+
backer on OpenCollective](https://opencollective.com/lambda-island) so that we
269+
can continue to make kaocha-cljs better.
270+
271+
<a href="https://opencollective.com/lambda-island">
272+
<img src="https://opencollective.com/lambda-island/organizations.svg?avatarHeight=46&width=800&button=false">
273+
<img src="https://opencollective.com/lambda-island/individuals.svg?avatarHeight=46&width=800&button=false">
274+
</a>
267275
<img align="left" src="https://github.com/lambdaisland/open-source/raw/master/artwork/lighthouse_readme.png">
268276

269277
&nbsp;
270278

271279
kaocha-cljs is part of a growing collection of quality Clojure libraries created and maintained
272280
by the fine folks at [Gaiwan](https://gaiwan.co).
273281

274-
Pay it forward by [becoming a backer on our Open Collective](http://opencollective.com/lambda-island),
275-
so that we may continue to enjoy a thriving Clojure ecosystem.
282+
Pay it forward by [becoming a backer on our OpenCollective](http://opencollective.com/lambda-island),
283+
so that we continue to enjoy a thriving Clojure ecosystem.
276284

277-
You can find an overview of our projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source).
285+
You can find an overview of all our different projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source).
278286

279287
&nbsp;
280288

@@ -284,39 +292,35 @@ You can find an overview of our projects at [lambdaisland/open-source](https://g
284292
<!-- contributing -->
285293
## Contributing
286294

287-
Everyone has a right to submit patches to kaocha-cljs, and thus become a contributor.
288-
289-
Contributors MUST
295+
We warmly welcome patches to kaocha-cljs. Please keep in mind the following:
290296

291297
- adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide)
292-
- write patches that solve a problem. Start by stating the problem, then supply a minimal solution. `*`
293-
- agree to license their contributions as MPL 2.0.
294-
- not break the contract with downstream consumers. `**`
295-
- not break the tests.
298+
- write patches that solve a problem
299+
- start by stating the problem, then supply a minimal solution `*`
300+
- by contributing you agree to license your contributions as MPL 2.0
301+
- don't break the contract with downstream consumers `**`
302+
- don't break the tests
296303

297-
Contributors SHOULD
304+
We would very much appreciate it if you also
298305

299-
- update the CHANGELOG and README.
300-
- add tests for new functionality.
306+
- update the CHANGELOG and README
307+
- add tests for new functionality
301308

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

309-
`*` This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution.
315+
`*` 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.
310316

311-
`**` As long as this project has not seen a public release (i.e. is not on Clojars)
312-
we may still consider making breaking changes, if there is consensus that the
313-
changes are justified.
317+
`**` 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.
314318
<!-- /contributing -->
315319

316320
<!-- license -->
317321
## License
318322

319-
Copyright &copy; 2018-2021 Arne Brasseur and Contributors
323+
Copyright &copy; 2018-2025 Arne Brasseur and Contributors
320324

321325
Licensed under the term of the Mozilla Public License 2.0, see LICENSE.
322-
<!-- /license -->
326+
<!-- /license -->

0 commit comments

Comments
 (0)