Update instructions for humans and agents
CI / Build (push) Waiting to run
CI / Lint (push) Blocked by required conditions
CI / Lua (push) Blocked by required conditions
CI / Neovim 0.10 Linux (push) Blocked by required conditions
CI / Neovim 0.12 Linux (push) Blocked by required conditions
CI / Vim 8.2 Linux (push) Blocked by required conditions
CI / Vim 9.2 Linux (push) Blocked by required conditions
CI / Neovim 0.10 Windows (push) Waiting to run
CI / Neovim 0.12 Windows (push) Waiting to run
CI / Vim 8.2 Windows (push) Waiting to run
CI / Vim 9.2 Windows (push) Waiting to run

This commit is contained in:
w0rp
2026-05-16 22:26:46 +01:00
parent ec599ef5a7
commit c25eaa30df
3 changed files with 41 additions and 9 deletions
+22 -5
View File
@@ -1,6 +1,23 @@
# ALE Agent instructions
# ALE Instructions
1. Read documentation from `doc/ale-development.txt` to understand how to be an
ALE developer.
2. Run Vader/Vim tests with `./run-tests -q --fast test/path/some_file.vader`
3. When editing Lua code run Lua tests with `./run-tests -q --lua-only`
## Basic Instructions
Read documentation from @doc/ale-development.txt to understand how to be an
ALE developer and how to match our standards.
Run all tests quickly with `./run-tests -q --fast`, which picks the quickest
version of Neovim we can run, and runs our linting checks.
You can quickly check an individual Vader test file by passing them as arguments
such as `./run-tests -q --fast test/path/some_file.vader`.
You can quickly run all Lua tests with `./run-tests -q --lua-only`.
For new Vim files, set `Author:` comments to the person doing the work.
Do not use Codex, OpenAI, or other tool names as the author.
## Writing Tests
For `test/test-files` they should almost always be 0 bytes in size and files
may be marked executable when testing searching for executables.
+18 -3
View File
@@ -202,9 +202,24 @@ See |ale-development-linter-tests| for more information on how to write linter
tests.
When you add new linters or fixers, make sure to add them into the tables in
supported-tools.md and |ale-supported-languages-and-tools.txt|. If you forget to
keep them both in sync, you should see an error like the following in the
builds run for GitHub Actions.
`../supported-tools.md` and |ale-supported-languages-and-tools.txt|.
The supported tools lists are very long, so please bear in mind the meanings
of the emojis and special characters in the Vim help file.
>
| Key | Definition |
| -------------- | ----------------------------------------------------- |
|:speech_balloon:| Language Server Protocol (LSP) |
| :floppy_disk: | Only runs on disk (see: `help ale-lint-file-linters`) |
| :warning: | Disabled by default |
<
>
`^` No linters for text or Vim help filetypes are enabled by default.
`!!` These linters check only files on disk. See |ale-lint-file-linters|
<
If you forget to keep them both in sync, you should see an error like the
following in the builds run for GitHub Actions.
>
========================================
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
+1 -1
View File
@@ -17,7 +17,7 @@ formatting.
| Key | Definition |
| -------------- | ----------------------------------------------------------------- |
|:speech_balloon:| Language Server Protocol (LSP) |
| :floppy_disk: | May only run on files on disk (see: `help ale-lint-file-linters` |
| :floppy_disk: | May only run on files on disk (see: `help ale-lint-file-linters`) |
| :warning: | Disabled by default |
---