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
kaocha-cljs is part of a growing collection of quality Clojure libraries created and maintained
272
280
by the fine folks at [Gaiwan](https://gaiwan.co).
273
281
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.
276
284
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).
278
286
279
287
280
288
@@ -284,39 +292,35 @@ You can find an overview of our projects at [lambdaisland/open-source](https://g
284
292
<!-- contributing -->
285
293
## Contributing
286
294
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:
290
296
291
297
- 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
296
303
297
-
Contributors SHOULD
304
+
We would very much appreciate it if you also
298
305
299
-
- update the CHANGELOG and README.
300
-
- add tests for new functionality.
306
+
- update the CHANGELOG and README
307
+
- add tests for new functionality
301
308
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.
308
314
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.
310
316
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.
0 commit comments