Skip to content

Commit 1b5723d

Browse files
committed
Add a "Contributing" section to the README
1 parent 710d5ff commit 1b5723d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -636,6 +636,27 @@ simple - the initial Tree-sitter support in Emacs 29 had quite a few issues and
636636
we felt it's better to nudge most people interested in using it to Emacs 30,
637637
which fixed a lot of the problems.
638638

639+
## Contributing
640+
641+
We welcome contributions of any kind!
642+
643+
If you're not familiar with Tree-sitter, a good place to start is our
644+
[design documentation](doc/design.md), which explains how Tree-sitter
645+
works in Emacs in broad strokes and covers some of the design
646+
decisions we've made a long the way.
647+
648+
We're using [Eldev](https://github.com/emacs-eldev/eldev) as our build tool, so you'll
649+
have to install it. We also provide a simple [Makefile](Makefile) with targets invoking Eldev. You
650+
only need to know a couple of them:
651+
652+
```shell
653+
make lint
654+
655+
make test
656+
```
657+
658+
The process of releasing a new version of `clojure-ts-mode` is documented [here](doc/release-process).
659+
639660
## License
640661

641662
Copyright © 2022-2025 Danny Freeman, Bozhidar Batsov and [contributors][].

0 commit comments

Comments
 (0)