[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/treesit-fold 26bcac9cfb 008/417: add contribution guide
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/treesit-fold 26bcac9cfb 008/417: add contribution guide |
Date: |
Mon, 1 Jul 2024 10:02:04 -0400 (EDT) |
branch: elpa/treesit-fold
commit 26bcac9cfb03b3824c50e5a926fcdc1e183b071e
Author: Junyi Hou <junyi.yi.hou@gmail.com>
Commit: Junyi Hou <junyi.yi.hou@gmail.com>
add contribution guide
---
readme.org | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/readme.org b/readme.org
index 96c4691e1a..5714118927 100644
--- a/readme.org
+++ b/readme.org
@@ -44,6 +44,15 @@ This is an alist whose keys are ~major-mode~ symbols, and
the corresponding valu
This variable determines how ~tree-sitter-fold~ should fold each of the nodes
defined in ~tree-sitter-fold-foldable-node-alist~. It is a nested alist, with
the first key being the major mode, and second key being the
~tree-sitter-node-type~. The value should be a function that takes a
~tree-sitter-node~ as the single argument, and return a cons cell of buffer
position as the range should be folded by ~tree-sitter-fold~. See
~tree-sitter-fold-range-python~ for an example.
+* Supported languages
+
+- python
+- contribution of other languages are welcome!
+
+* Contribution
+
+Enable ~tree-sitter-mode~ first, then ~tree-sitter-query-builder~ is useful to
test out queries that determine what syntax nodes should be foldable and how to
fold them. emacs-tree-sitter has
[[https://ubolonton.github.io/emacs-tree-sitter/syntax-highlighting/queries/][an
excellent documentation]] on how to write ~tree-sitter~ queries.
+
* License
MIT
- [nongnu] branch elpa/treesit-fold created (now f66e2b8be9), ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold ce21a60d23 001/417: init commit, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 2f826374a8 007/417: add installation guide, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold e28c905a45 006/417: improve error message when no foldable node under point, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold d3665fd07a 013/417: update readme, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 26bcac9cfb 008/417: add contribution guide,
ELPA Syncer <=
- [nongnu] elpa/treesit-fold 510f3ff119 018/417: update readme, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 3a66cdeb1a 002/417: update readme, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold e7dd19b2d1 005/417: fix compile bug: add to evil-fold-list only if it exist, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 568085877e 014/417: better notes on how to install additional grammars, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 2ad70aae0d 023/417: Remove unused format function, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 88b0e6eab0 039/417: Update doc, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 557df0a4fe 045/417: Add replacement customization, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 6603e0ddbb 057/417: Split parser, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold 7127f4bbcc 061/417: Add comment, ELPA Syncer, 2024/07/01
- [nongnu] elpa/treesit-fold c6f58d41d5 068/417: Fix, ELPA Syncer, 2024/07/01