mirror of
https://github.com/dense-analysis/ale.git
synced 2026-08-02 06:00:26 +08:00
Update instructions for humans and agents
CI / Build (push) Has been cancelled
CI / Neovim 0.10 Windows (push) Has been cancelled
CI / Neovim 0.12 Windows (push) Has been cancelled
CI / Vim 8.2 Windows (push) Has been cancelled
CI / Vim 9.2 Windows (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Lua (push) Has been cancelled
CI / Neovim 0.10 Linux (push) Has been cancelled
CI / Neovim 0.12 Linux (push) Has been cancelled
CI / Vim 8.2 Linux (push) Has been cancelled
CI / Vim 9.2 Linux (push) Has been cancelled
CI / Build (push) Has been cancelled
CI / Neovim 0.10 Windows (push) Has been cancelled
CI / Neovim 0.12 Windows (push) Has been cancelled
CI / Vim 8.2 Windows (push) Has been cancelled
CI / Vim 9.2 Windows (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Lua (push) Has been cancelled
CI / Neovim 0.10 Linux (push) Has been cancelled
CI / Neovim 0.12 Linux (push) Has been cancelled
CI / Vim 8.2 Linux (push) Has been cancelled
CI / Vim 9.2 Linux (push) Has been cancelled
This commit is contained in:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user