branch: elpa/clojure-ts-mode
commit 1b5723de13041cd29c6875a905f36ce6392c8adb
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Add a "Contributing" section to the README
---
README.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/README.md b/README.md
index b742c76e0e..42133d6858 100644
--- a/README.md
+++ b/README.md
@@ -636,6 +636,27 @@ simple - the initial Tree-sitter support in Emacs 29 had
quite a few issues and
we felt it's better to nudge most people interested in using it to Emacs 30,
which fixed a lot of the problems.
+## Contributing
+
+We welcome contributions of any kind!
+
+If you're not familiar with Tree-sitter, a good place to start is our
+[design documentation](doc/design.md), which explains how Tree-sitter
+works in Emacs in broad strokes and covers some of the design
+decisions we've made a long the way.
+
+We're using [Eldev](https://github.com/emacs-eldev/eldev) as our build tool,
so you'll
+have to install it. We also provide a simple [Makefile](Makefile) with targets
invoking Eldev. You
+only need to know a couple of them:
+
+```shell
+make lint
+
+make test
+```
+
+The process of releasing a new version of `clojure-ts-mode` is documented
[here](doc/release-process).
+
## License
Copyright © 2022-2025 Danny Freeman, Bozhidar Batsov and [contributors][].
