You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
25
33
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.
31
36
32
-
37
+
You can find an overview of all our different projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source).
33
38
34
39
35
40
41
+
36
42
<!-- /opencollective -->
37
43
38
44
## Installation
@@ -243,33 +249,29 @@ the future. When in doubt check the CHANGELOG.
243
249
<!-- contributing -->
244
250
## Contributing
245
251
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:
249
253
250
254
- 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
255
260
256
-
Contributors SHOULD
261
+
We would very much appreciate it if you also
257
262
258
-
- update the CHANGELOG and README.
259
-
- add tests for new functionality.
263
+
- update the CHANGELOG and README
264
+
- add tests for new functionality
260
265
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.
267
271
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.
269
273
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.
273
275
<!-- /contributing -->
274
276
275
277
## Credits
@@ -292,7 +294,7 @@ Another library that implements a form of data structure diffing is [editscript]
0 commit comments