Skip to content

Commit e77c3bf

Browse files
committed
Update automated readme blocks
1 parent 33621d1 commit e77c3bf

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

README.md

+33-31
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# lambdaisland/deep-diff2
22

33
<!-- badges -->
4-
[![CircleCI](https://circleci.com/gh/lambdaisland/deep-diff2.svg?style=svg)](https://circleci.com/gh/lambdaisland/deep-diff2) [![cljdoc badge](https://cljdoc.org/badge/lambdaisland/deep-diff2)](https://cljdoc.org/d/lambdaisland/deep-diff2) [![Clojars Project](https://img.shields.io/clojars/v/lambdaisland/deep-diff2.svg)](https://clojars.org/lambdaisland/deep-diff2) [![bb compatible](https://raw.githubusercontent.com/babashka/babashka/master/logo/badge.svg)](https://babashka.org)
4+
[![CircleCI](https://circleci.com/gh/lambdaisland/deep-diff2.svg?style=svg)](https://circleci.com/gh/lambdaisland/deep-diff2) [![cljdoc badge](https://cljdoc.org/badge/lambdaisland/deep-diff2)](https://cljdoc.org/d/lambdaisland/deep-diff2) [![Clojars Project](https://img.shields.io/clojars/v/lambdaisland/deep-diff2.svg)](https://clojars.org/lambdaisland/deep-diff2)
55
<!-- /badges -->
66

77
Recursively compare Clojure or ClojureScript data structures, and produce a colorized diff of the result.
@@ -14,25 +14,31 @@ if you want to programatically diff/patch Clojure data structures then
1414
[this write-up by Huahai Yang](https://juji.io/blog/comparing-clojure-diff-libraries/).
1515

1616
<!-- opencollective -->
17+
## Lambda Island Open Source
1718

18-
&nbsp;
19+
Thank you! deep-diff2 is made possible thanks to our generous backers. [Become a
20+
backer on OpenCollective](https://opencollective.com/lambda-island) so that we
21+
can continue to make deep-diff2 better.
1922

23+
<a href="https://opencollective.com/lambda-island">
24+
<img src="https://opencollective.com/lambda-island/organizations.svg?avatarHeight=46&width=800&button=false">
25+
<img src="https://opencollective.com/lambda-island/individuals.svg?avatarHeight=46&width=800&button=false">
26+
</a>
2027
<img align="left" src="https://github.com/lambdaisland/open-source/raw/master/artwork/lighthouse_readme.png">
2128

2229
&nbsp;
2330

24-
## Support Lambda Island Open Source
31+
deep-diff2 is part of a growing collection of quality Clojure libraries created and maintained
32+
by the fine folks at [Gaiwan](https://gaiwan.co).
2533

26-
deep-diff2 is part of a growing collection of quality Clojure libraries and
27-
tools released on the Lambda Island label. If you are using this project
28-
commercially then you are expected to pay it forward by
29-
[becoming a backer on Open Collective](http://opencollective.com/lambda-island#section-contribute),
30-
so that we may continue to enjoy a thriving Clojure ecosystem.
34+
Pay it forward by [becoming a backer on our OpenCollective](http://opencollective.com/lambda-island),
35+
so that we continue to enjoy a thriving Clojure ecosystem.
3136

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

3439
&nbsp;
3540

41+
&nbsp;
3642
<!-- /opencollective -->
3743

3844
## Installation
@@ -243,33 +249,29 @@ the future. When in doubt check the CHANGELOG.
243249
<!-- contributing -->
244250
## Contributing
245251

246-
Everyone has a right to submit patches to deep-diff2, and thus become a contributor.
247-
248-
Contributors MUST
252+
We warmly welcome patches to deep-diff2. Please keep in mind the following:
249253

250254
- adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide)
251-
- write patches that solve a problem. Start by stating the problem, then supply a minimal solution. `*`
252-
- agree to license their contributions as EPL 1.0.
253-
- not break the contract with downstream consumers. `**`
254-
- not break the tests.
255+
- write patches that solve a problem
256+
- start by stating the problem, then supply a minimal solution `*`
257+
- by contributing you agree to license your contributions as EPL 1.0
258+
- don't break the contract with downstream consumers `**`
259+
- don't break the tests
255260

256-
Contributors SHOULD
261+
We would very much appreciate it if you also
257262

258-
- update the CHANGELOG and README.
259-
- add tests for new functionality.
263+
- update the CHANGELOG and README
264+
- add tests for new functionality
260265

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

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

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

275277
## Credits
@@ -292,7 +294,7 @@ Another library that implements a form of data structure diffing is [editscript]
292294
<!-- license -->
293295
## License
294296

295-
Copyright &copy; 2018-2020 Arne Brasseur and contributors
297+
Copyright &copy; 2018-2024 Arne Brasseur and contributors
296298

297299
Available under the terms of the Eclipse Public License 1.0, see LICENSE.txt
298-
<!-- /license -->
300+
<!-- /license -->

0 commit comments

Comments
 (0)