Skip to content

Commit a023feb

Browse files
committed
Prepare for merge to main: update status [skip ci]
Update project status in README
1 parent 1557053 commit a023feb

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

README.adoc

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,21 @@ https://clojars.org/rewrite-clj[image:https://img.shields.io/clojars/v/rewrite-c
1414

1515
A library that reads and writes Clojure, ClojureScript and https://github.com/edn-format/edn[EDN] from Clojure and ClojureScript in a whitespace and comment preserving way.
1616

17-
[WARNING]
18-
====
19-
Status: Currently migrating to clj-commons/rewrite-clj.
20-
See: https://github.com/clj-commons/rewrite-clj/projects/1[GitHub project page for current priorities].
21-
====
17+
== Status
18+
19+
*Warning*: v1 Alpha Release
20+
21+
* Migration from https://github.com/lread/rewrite-cljc-playground[rewrite-cljc-playground] complete.
22+
Rewrite-cljc-playground is where I first merged rewrite-clj v0 and rewrite-cljs.
23+
* We are automatically link:doc/02-developer-guide.adoc#libs-test[testing against popular libraries].
24+
We patch them to use rewrite-clj v1 and then run their test suites.
25+
Only a minor failure on zprint v1.1.1 was found due to intentional breaking changes in namespaced maps.
26+
* Please review link:CHANGELOG.adoc[change log] for an overview of all v1 changes.
27+
* I am very conservative on making any further v0->v1 breaking changes, but am open to breaking changes to any of the new v1 work.
28+
29+
We'll move out of alpha after folks have had a chance to give rewrite-clj v1 alpha a good shake. Things look solid but I would be very surprised if there are no issues and/or feedback.
30+
31+
See https://github.com/clj-commons/rewrite-clj/projects/1[project page for current priorities].
2232

2333
== Docs
2434

@@ -32,7 +42,7 @@ See: https://github.com/clj-commons/rewrite-clj/projects/1[GitHub project page f
3242

3343
Rewrite-clj versioning scheme is: `major`.`minor`.`patch`-`test-qualifier`
3444

35-
* `major` increments when the API has been broken - something, as a rule, we'd like to avoid.
45+
* `major` increments when a non alpha release API has been broken - something, as a rule, we'd like to avoid.
3646
* `minor` increments to convey significant new features have been added.
3747
* `patch` indicates bug fixes - it is the total number of commits in the repo.
3848
* `test-qualifier` is absent for stable releases. Can be `alpha`, `beta`, `rc1`, etc.

doc/02-developer-guide.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ bb ./script/pure_native_test.clj
199199
bb ./script/sci_native_test.clj
200200
----
201201

202+
[#libs-test]
202203
=== Libs test
203204
To try to ensure our changes to rewrite-clj do not inadvertently break existing popular libraries, we run their tests, or a portion thereof, against rewrite-clj.
204205

0 commit comments

Comments
 (0)