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
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:
212
206
213
207
- 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
218
213
219
-
Contributors SHOULD
214
+
We would very much appreciate it if you also
220
215
221
-
- update the CHANGELOG and README.
222
-
- add tests for new functionality.
216
+
- update the CHANGELOG and README
217
+
- add tests for new functionality
223
218
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.
230
224
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.
232
226
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.
0 commit comments