vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

commit dd99e7961de9880057d45300fe1b7a0c387e5fc6
parent f151cf102aa3a60f487698c15285018b6f8201ea
Author: Andrew Laack <andrew@laack.co>
Date:   Fri, 16 Oct 2026 16:44:20 -0500

Remove slop

Diffstat:
DAGENTS.md | 335-------------------------------------------------------------------------------
DCODE_OF_CONDUCT.md | 135-------------------------------------------------------------------------------
DCONTRIBUTING.md | 203-------------------------------------------------------------------------------
3 files changed, 0 insertions(+), 673 deletions(-)

diff --git a/AGENTS.md b/AGENTS.md @@ -1,335 +0,0 @@ -# AGENTS.md - -Guidance for AI coding agents working in the Vim repository. - -## Project - -Vim is a text editor written in C. The canonical repository is -https://github.com/vim/vim. The code is old and has grown organically over -the past 30+ years. Some files are vendored from upstream projects -(`src/xdiff`, `src/libvterm`); parts of the runtime are occasionally shared -with forks like Neovim. - -Vim strives to be portable across several different operating systems and -aims to be a stable, robust editor gradually developing new features while -remaining backwards compatible as much as possible. - -At the same time, Vim can be compiled with different feature sets, from the -POSIX compatible minimal vi to a full-fledged GUI editor which includes -additional scripting interfaces. - -See `runtime/doc/develop.txt` for the high level design goals. - -## Build and test - - # Full build on Unix/Linux (from src/): - make - - # Run the full test suite: - make test - - # Generate proto files - make proto - - # Run a single test file: - cd src/testdir && make test_name.res - -Output is in testdir/messages and testdir/test.log - -Builds on Windows depend on the Environment, see `src/INSTALLpc.txt` -for Cygwin/MSYS and MSVC ways to build Vim - -Before submitting any patch, at minimum: -1. The build succeeds without new warnings. -2. Relevant tests pass. -3. The code matches the style of the file being edited. - -## Layout - -- `src/` - the C source. Subsystem names are usually obvious from filenames - (`buffer.c`, `window.c`, `search.c`, `vim9compile.c`, etc.). -- `src/proto/` - function prototypes, one `.pro` file per source file. - Regenerated; do not hand-edit unless you know what you're doing. -- `src/po` - Translations -- `src/xxd` - for the xxd subproject -- `src/xdiff` - for the xdiff library (imported from git) -- `src/libvterm` - for the libvterm library -- `src/testdir/` - tests. Vim-script files named `test_*.vim`. - Screendump expected output lives in `src/testdir/dumps/`. -- `runtime/doc/` - user-facing documentation in Vim help format, when updating, - also update the Last Change header -- `runtime/syntax/generator` - Syntax script for Vim Script, automatically generated - from Vims source -- `runtime/` - runtime files shipped with Vim, when updating, also update the - Last Change header and a short description if this file has no maintainer - If the file has a maintainer, changes should go via them (so make a merge - request against the upstream repo instead) -- `src/version.c` - contains the `included_patches[]` list. Every - patch touching anything below `src/` (with the exception of `src/po`) needs a - new entry at the top, will be updated only when merging into - the master tree. - -## Commit format - -Vim uses a strict commit message format. The subject line is a -one-sentence **problem statement**, not a description of the fix: - - short description of the problem - - Problem: Restatement of the problem as a full sentence, possibly - with a reporter attribution in parentheses. - Solution: Short description of the fix, ending with the author's - name in parentheses. - - optional longer description of the problem and solution goes here in prose. - Do not use bullet points. - - fixes: #NNNN - related: #NNNN - closes: #NNNN - - Assisted-by: <AI tool> - Co-authored-by: Name - Signed-off-by: Author Name <email> - -Rules: - -- **Subject line states the problem**, not the solution. "fix typo" is - wrong; "typo in foo() causes OOB read" is right. -- **Problem line is a full sentence with a trailing period.** It mirrors - the subject. -- **Solution line ends with `(Author Name)`** — parentheses, period - after them. -- **Longer prose**, if any, goes after the Problem/Solution header -- **`fixes:` references the issue** the patch fixes. - **`closes:` references the PR** that introduces the fix. - **`related:` references related issues**, including issues that caused this - one. - All can appear. Colon, aligned, no trailing period. -- **`Signed-off-by:` is required** for the Developer Certificate of Origin (DCO). -- **`Co-Authored-by:` is allowed** and is the accepted way to - acknowledge human assistance transparently. Human coauthors should usually - also have their own Signed-off-by. -- **`Assisted-by:` is required** when AI was used. - -## C code conventions - -- **Indentation is 4 spaces per level.** Existing files use tabs with - `ts=8 sts=4 sw=4 noet` (set by the modeline in the file), - so tabs of width 8 appear where two levels of indent collapse. `sign.c`, - `sound.c`, and any new file must use spaces only and follow the style from - the .editorconfig file. -- **Opening braces go on their own line (Allman style)** — for function - definitions and for control-flow constructs (`if`/`else`/`for`/`while`/ - `do`) alike. -- **Function definitions**: return type on its own indented line, with - the function name beginning on the next line. -- Initialize locals where a reader cannot trivially see the first - assignment (common for pointers and return-value accumulators). - Don't add `= 0` initializers for values that are always assigned - before use — they can hide real uninitialized-read bugs from - the compiler. -- `for (int i = 0; ...)` loop declarations are fine in files that - use them; older files may declare the counter at the top of the - block. -- **Function-scope declarations at the top of a block** is the historical - style, but mid-block declarations are acceptable in files that have - adopted them. Match the surrounding code. -- **Custom types end in `_T`** (e.g., `buf_T`, `linenr_T`, `pos_T`). - Never use `_t` — it collides with POSIX typedefs. -- **C language is C95 plus specific C99 features**: `//` comments, - mixed declarations and statements, `__func__`, `bool`/`_Bool`, - variadic macros, compound literals, `static inline`, trailing enum - commas. Do not reach for later C standards — Vim still must build - with Compaq C on OpenVMS. See `*assumptions-C-compiler*` in - `develop.txt` for the full list. -- **`bool` / `true` / `false` are acceptable.** Vim is transitioning - from `int` with `TRUE`/`FALSE` to C99 `bool`. Do not "fix" `bool` - back to `int`. Within a single patch, be consistent — don't mix - `true` and `TRUE` in new code. -- **Do not mass-convert** `TRUE`/`FALSE` to `true`/`false` across files - unless that is the patch's explicit purpose. Opportunistic - conversions create noise in diffs. -- **`STRLEN_LITERAL("...")`** should be used when the length of a - string literal is needed. Avoid `STRLEN()` on literals. -- **`vim_snprintf_safelen()`** returns the written length; prefer it - over `vim_snprintf()` when the length is then needed. -- **Prefer `dict_add_string_len()`** when the string length is already - known, over `dict_add_string()` which calls `STRLEN()`. -- **String/buffer parameters go `(char_u *buf, size_t buflen)`** — - length alongside pointer, in bytes. Use `size_t` for byte counts, - `int` only where required by legacy APIs. -- **Guards before divisions.** Check for divisor zero explicitly, even - when a composite earlier guard would prevent it. Relying on - transitive guards is fragile. -- When introducing new allocations, verify the cleanup paths handle all exit - conditions (early return, error branches, etc). - -**Use Vim wrappers instead of libc where one exists:** - -| libc | Vim | Why | -|---------------|------------------------|-----------------------------| -| `free()` | `vim_free()` | Tolerates NULL | -| `malloc()` | `alloc()` / `lalloc()` | Checks for OOM | -| `strcpy()` | `STRCPY()` | Cast for `char_u *` | -| `strchr()` | `vim_strchr()` | Handles special characters | -| `strrchr()` | `vim_strrchr()` | Handles special characters | -| `memcpy()` | `mch_memmove()` | Handles overlapping copies | -| `bcopy()` | `mch_memmove()` | Handles overlapping copies | -| `memset()` | `vim_memset()` | Uniform across systems | -| `isspace()` | `vim_isspace()` | Handles bytes > 127 | -| `iswhite()` | `vim_iswhite()` | TRUE only for tab and space | - -Further rules, not spelled out here, live in `runtime/doc/develop.txt`: - -- `*style-names*` — reserved name patterns (`is*`, `to*`, `str*`, `mem*`, - `wcs*`, `.*_t`, `__.*`), forbidden identifiers (`delete`, `this`, `new`, - `time`, `index`), and the 31-character function-name limit. -- `*style-spaces*`, `*style-examples*` — spacing and one-statement-per-line. -- `*style-various*` — `FEAT_` feature prefix, uppercase `#define`, - `#ifdef HAVE_X` rather than `#if HAVE_X`, no `'\"'`. -- `*assumptions-makefiles*` — POSIX.1-2001 `make` only in the main - Makefiles (no `%` rules, `:=`, `.ONESHELL`, GNU conditionals). -- Vim uses `char_u` instead of `char` type -- Vim uses the macros `STRLEN`, `STRCPY`, `STRCMP`, `STRCAT` that work - with the `char_u` type. -- `*style-clang-format*` — `sign.c` and `sound.c` are formatted with - `clang-format`; re-run it after editing those files. - -## Vim9 script conventions (in tests and runtime files) - -- Write modern Vim style (new files can use Vim9 script, but compatibility - with Neovim and other forks is a concern, so in doubt please ask!) -- **Drop `l:` prefix from local variables** in Vim-script tests. -- **Don't add `CheckFeature` inside individual tests** if it's already - at the top of the file. -- If a test file doesn't gate features at the top, add CheckFeature to - individual tests that depend on specific build features. - -## Test conventions - -- Tests are in `src/testdir/test_*.vim`. -- Reproducible tests beat "it doesn't crash" tests. If a patch fixes - a rendering bug, add a screendump test. If it fixes incorrect output, - assert the output. -- Add comprehensive tests for newly added features and include them - in existing tests if possible -- **Screendump tests** use `CheckScreendump`, `RunVimInTerminal`, - `VerifyScreenDump`, and live dumps in `src/testdir/dumps/`. -- `v9.CheckScriptSuccess(lines)` / `v9.CheckScriptFailure(lines, error, lnum)` - are the standard way to test Vim9 script behavior at script-load time. -- **Garbage Collection tests** Always write GC tests as a legacy func - Test_...(), using let lines =<< trim END and call - v9.CheckSourceSuccess(lines) with test_garbagecollect_now() invoked at script - level inside lines (see Test_enum_garbagecollect() in - src/testdir/test_vim9_enum.vim). Never call test_garbagecollect_now() while a - Vim9 :def function is on the call stack—including passing lines from a def - test—because :def stack values are not marked during GC, resulting in memory - errors or crashes. -- When fixing a bug reported as an issue, include a test that - reproduces the original report, not just a minimal synthetic case. -- Tests for Syntax runtime are in `runtime/syntax/testdir` -- Tests for Indent runtime are in `runtime/indent/testdir` - -## Common gotchas - -- **Distinguish what code enforces from what docs claim.** If a patch - changes documented behavior, say so in the Problem/Solution. -- **Generated files** (`src/auto/configure`, generated Wayland protocol - C, etc.) should only be regenerated when their source changes. - Mixing unrelated regeneration into a functional patch creates noise. - -## Documentation - -- User-facing option or feature changes require a `runtime/doc/*.txt` - update in the same patch. -- When editing an existing help file, bump the `Last change:` header - at the top. - -### Help file style - -See `runtime/doc/helphelp.txt` (`*help-writing*`) for the authoritative -reference. Key conventions: - -- **File header**: first line is `*filename.txt*` then a tab then a - short description. That description appears under `LOCAL ADDITIONS` - in `help.txt`. The version and `Last change:` date go on the second - line, right aligned. -- **Modeline**: every help file ends with a Vim modeline — typically - `vim:tw=78:ts=8:noet:ft=help:norl:`. -- **Layout**: `'textwidth'` 78, `'tabstop'` 8, indent and align with - tab characters. Two spaces between sentences. Run `:retab` - (not `:retab!`, and review the diff) after editing. -- **Tags** are defined as `*tag-name*`, usually right-aligned on the - line where the thing they name is introduced. Tag names must be - unique across all of `runtime/doc/`; for plugin help, prefix with - the plugin name. -- **Cross-references inside help text**: - - `|tag-name|` — hot-link to an existing tag. - - `` `:cmd` `` — Ex command, highlighted as a code block. - - `'option'` — option name, in single quotes. - - `<Key>` or `CTRL-X` — special keys. - - `{placeholder}` — user-supplied argument. -- **Sections** are separated by a line of `=` starting in column 1. - Column or subsection headings end with `~` to trigger heading - highlighting. -- **Code blocks** start with `>` at the end of the introducing line - and end with `<` as the first non-blank on a later line (any line - starting in column 1 also implicitly closes the block). Use `>vim` - (or another language name) to request syntax highlighting inside - the block. -- **Notation** — `Note`, `Todo`, `Error` and a few similar words are - auto-highlighted; do not try to fake the highlighting by other means. -- **Language**: gender-neutral language is preferred for new or updated - text; existing wording does not need to be rewritten for this alone. - -## Release policy - -Vim alternates between development cycles and stability periods — see -`runtime/doc/develop.txt` `*design-policy*`. - -- **During a stability period** only clear bug fixes, security fixes, - documentation updates, translations, and runtime file updates are - accepted. No new features, no backwards-incompatible changes. -- **Once released in a minor version**, C-core features must stay - backwards-compatible. Runtime files have a bit more flexibility so - their maintainers can correct old behavior. -- **Deprecated features** stay reachable via config (do not hard-error), - are documented as deprecated, can be disabled at compile time, and - may be removed in a later cycle. - -## Security - -Before reporting a suspected security issue or submitting a patch -that touches security-sensitive code, read `SECURITY.md`. Follow -the disclosure process described there. - -## Before submitting - -1. Commit message follows the format above. -2. All modified code compiles without new warnings. -3. Tests pass, and new functionality has regression tests. -4. Documentation is updated for user-visible changes. -5. Signed-off-by is present. -6. Diff contains only changes relevant to the stated problem — - no stray whitespace fixes, no unrelated refactors, no unrelated - regeneration of `auto/configure`. -7. For multi-patch series: each commit compiles and passes its own - tests. A known-broken intermediate state that a later patch fixes - is not acceptable — squash instead. - -## When in doubt - -- Make the smallest possible change to achieve the goal. Do not rewrite - entire files or functions when a targeted edit suffices. -- Read surrounding code and match its style rather than imposing an - "improvement." -- Err toward smaller, more focused patches. A patch that does three - things is three patches. -- If a patch fixes a symptom of a deeper bug, say so in the Problem - and acknowledge the scope limitation in the Solution. -- Before claiming a bug exists, reproduce it. Before claiming code does X, read - the code. Do not rely on training-data memory of file contents. -- Before running shell commands that modify files outside the working tree, - install packages, push branches, or invoke network operations, confirm with - the user. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md @@ -1,135 +0,0 @@ -# Vim Code of Conduct - -Vim has been built for decades by people from all over the world, most of -whom do not speak English as their first language. We want to keep it a -place where people enjoy working together. - -## Our Pledge - -We pledge to make our community welcoming, safe, and equitable for all. - -We are committed to fostering an environment that respects and promotes the -dignity, rights, and contributions of all individuals, regardless of -characteristics including race, ethnicity, caste, color, age, physical -characteristics, neurodiversity, disability, sex or gender, gender identity or -expression, sexual orientation, language, philosophy or religion, national or -social origin, socio-economic position, level of education, or other status. -The same privileges of participation are extended to everyone who participates -in good faith and in accordance with this Code of Conduct. - -## Encouraged Behaviors - -While acknowledging differences in social norms, we all strive to meet our -community's expectations for positive behavior. We also understand that our -words and actions may be interpreted differently than we intend based on -culture, background, or native language. - -With these considerations in mind, we agree to behave mindfully toward each -other and act in ways that center our shared values, including: - -1. Respecting the **purpose of our community**, our activities, and our ways of - gathering. -2. Engaging **kindly and honestly** with others. -3. Respecting **different viewpoints** and experiences. -4. **Taking responsibility** for our actions and contributions. -5. Gracefully giving and accepting **constructive feedback**. -6. Committing to **repairing harm** when it occurs. -7. Behaving in other ways that promote and sustain the **well-being of our - community**. - -Most of us do not speak English as our first language. Keep that in mind -when reading others' words, and do not use it as an excuse for rudeness. - -Maintainers make the final decision on contributions, even when you -disagree. - -## Restricted Behaviors - -We agree to restrict the following behaviors in our community. Instances, -threats, and promotion of these behaviors are violations of this Code of -Conduct. - -1. **Harassment.** Violating explicitly expressed boundaries or engaging in - unnecessary personal attention after any clear request to stop. -2. **Character attacks.** Making insulting, demeaning, or pejorative comments - directed at a community member or group of people. -3. **Stereotyping or discrimination.** Characterizing anyone's personality or - behavior on the basis of immutable identities or traits. -4. **Sexualization.** Behaving in a way that would generally be considered - inappropriately intimate in the context or purpose of the community. -5. **Violating confidentiality.** Sharing or acting on someone's personal or - private information without their permission. -6. **Endangerment.** Causing, encouraging, or threatening violence or other - harm toward any person or group. -7. Behaving in other ways that **threaten the well-being** of our community. - -### Other Restrictions - -1. **Misleading identity.** Impersonating someone else for any reason, or - pretending to be someone else to evade enforcement actions. -2. **Failing to credit sources.** Not properly crediting the sources of content - you contribute. -3. **Promotional materials.** Sharing marketing or other commercial content in - a way that is outside the norms of the community. -4. **Irresponsible communication.** Failing to responsibly present content - which includes, links or describes any other restricted behaviors. -5. **Misusing project permissions.** Locking, closing, or blocking other - people's contributions or discussions without a stated reason. -6. **Manipulating discussions.** Voting on your own posts, using multiple - accounts, or otherwise creating a false impression of support. -7. **Driving people away.** Repeated hostility or dismissiveness that - discourages others from participating. - -### Use of AI in communication - -Discussions, reviews, and mailing list posts should be written by you, in -your own words. - -- Fine: spell checking, grammar correction, and machine translation of text - you wrote yourself (optionally mention that you used machine translation). -- Not fine: posting AI-generated replies, reviews, summaries, or comments, - whether marked as such or not. Anyone can generate such text at any - time. It adds no value to a discussion and wastes readers' time. -- If you want to share output from a tool (a static analyzer, a fuzzer, or - an AI review), quote it clearly as tool output, keep it short, and add - your own assessment of whether it is correct and relevant. - -## Reporting an Issue - -Tensions can occur between community members even when they are trying their -best to collaborate. Not every conflict represents a code of conduct violation, -and this Code of Conduct reinforces encouraged behaviors and norms that can -help avoid conflicts and minimize harm. - -Report problems privately to the current conduct team. -Reports are kept confidential. Members of the conduct team who are -involved in a reported issue will not take part in handling it. - -Conduct team: Christian Brabandt, Doug Kearns, Yegappan Lakshmanan, - Yasuhiro Matsumoto - -## Enforcement - -Depending on the severity, the conduct team may: - -1. Send a private warning explaining what was wrong. -2. Temporarily restrict participation. -3. Permanently ban from the project's spaces. - -This enforcement ladder is intended as a guideline. It does not limit the -ability of the conduct team to use their discretion and judgment, in keeping -with the best interests of the Vim community. - -## Scope - -This applies to all official Vim project spaces: the repositories of the -vim GitHub organization (issues, pull requests, discussions), the vim_dev -and vim_use mailing lists, and any other channel where someone acts on -behalf of the project. - -## Attribution - -Adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/3/0/), -version 3.0, by the Organization for Ethical Source, licensed under -[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). This -Code of Conduct is licensed under CC BY-SA 4.0 as well. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md @@ -1,203 +0,0 @@ -# Contributing to Vim - -Patches are welcome in whatever form. -Discussions about patches happen on the [vim-dev][0] mailing list. -If you create a pull request on GitHub it will be -forwarded to the vim-dev mailing list. You can also send your patch there -directly (but please note, the initial posting is subject to moderation). -In that case an attachment with a unified diff format is preferred. -Information about the mailing list can be found [on the Vim website][0]. - -A pull request has the advantage that it will trigger the Continuous -Integration tests, you will be warned of problems (you can ignore the coverage -warning, it's noisy). - -Do not submit a single PR that addresses multiple unrelated issues. - -Please always add a test, if possible. All new functionality should be tested -and bug fixes should be tested for regressions: the test should fail before the -fix and pass after the fix. Look through recent patches for examples and find -help with ":help testing". The tests are located under "src/testdir". - -Contributions will be distributed with Vim under the Vim license. Providing a -change to be included implies that you agree with this and your contribution -does not cause us trouble with trademarks or patents. There is no CLA to sign. - -## Signing-off commits - -While not required, it's recommended to use **Signed-off commits** to ensure -transparency, accountability, and compliance with open-source best practices. -Signed-off commits follow the [Developer Certificate of Origin (DCO)][15], -which confirms that contributors have the right to submit their changes under -the project's license. This process adds a `Signed-off-by` line to commit -messages, verifying that the contributor agrees to the project's licensing -terms. To sign off a commit, simply use the -s flag when committing: - -```sh -git commit -s -``` - -This ensures that every contribution is properly documented and traceable, -aligning with industry standards used in projects like the Linux Kernel or -the git project. By making Signed-off commits a standard practice, we help -maintain a legally compliant and well-governed codebase while fostering trust -within our contributor community. - -When merging PRs into Vim, the current maintainer @chrisbra usually adds missing -`Signed-off-by` trailers for the author user name and email address as well for -anybody that explicitly *ACK*s a pull request as a statement that those -approvers are happy with that particular change. - -## Using AI - -Use of AI is allowed within the limits mentioned below, but you remain fully -responsible for everything you submit. Disclosure of AI use is required, using -an `Assisted-by:` trailer. [AGENTS.md](AGENTS.md) contains information and -instructions for AI coding agents. - -### What is acceptable - -- Research, looking things up, understanding existing code. -- Small, targeted fixes (e.g. for security issues). -- Help with writing tests and benchmarks. - -### What is not acceptable - -- Large pull requests that were mostly generated. We may close pull - requests that are too large to review with confidence, whatever their - origin. Split large changes into smaller, reviewable steps. -- Answering review questions by pasting AI output. Reviewers want to hear - your own understanding of the change. -- Posting AI-generated reviews on other people's pull requests. Automated - CI checks are fine. -- Generated commit messages or PR descriptions. Write them yourself - that ensures you have a good understanding of the change. Fixing - spelling, grammar and translations is fine. - -### Your responsibility - -- You must understand every line of your change and be able to explain it. -- You must have the right to submit the code under the Vim license. -- You are expected to fix problems your change introduces. - -Maintainers decide whether a contribution is acceptable. See also the -[Code of Conduct](CODE_OF_CONDUCT.md), which covers the use of AI in -discussions. - -# Reporting issues - -We use GitHub [issues][17], but that is not a requirement. Writing to the Vim -mailing list is also fine. - -Please use the GitHub issues only for actual issues. If you are not 100% sure -that your problem is a Vim issue, please first discuss this on the Vim user -mailing list. Try reproducing the problem without any of your plugins or settings: - - vim --clean - -If you report an issue, please describe exactly how to reproduce it. -For example, don't say "insert some text" but say what you did exactly: -`ahere is some text<Esc>`. -Ideally, the steps you list can be used to write a test to verify the problem -is fixed. - -Feel free to report even the smallest problem, also typos in the documentation. - -You can find known issues in the todo file: `:help todo`. -Or open [the todo file][todo list] on GitHub to see the latest version. - -# Syntax, indent and other runtime files - -The latest version of these files can be obtained from the repository. -They are usually not updated with numbered patches. However, they may -or may not work with older Vim releases (since they may depend on new -features). - -If you find a problem with one of these files or have a suggestion for -improvement, please first try to contact the maintainer directly. -Look in the header of the file for the name, email address, GitHub handle and/or -upstream repository. You may also check the [MAINTAINERS][11] file. - -The maintainer will take care of issues and send updates to the Vim project for -distribution with Vim. - -If the maintainer does not respond, contact the [vim-dev][0] mailing list or -open an [issue][17] here. - -Note: Whether or not to use Vim9 script is up to the maintainer. For runtime -files maintained here, we aim to preserve compatibility with Neovim if -possible. Please wrap Vim9 script with a guard like this: -```vim -if has('vim9script') - " use Vim9 script implementation - [...] -endif -``` - -## Contributing new runtime files - -If you want to contribute new runtime files for Vim or Neovim, please create a -PR with your changes against this repository here. For new filetypes, do not forget: - -- to add a new [filetype test][12] (keep it similar to the other filetype tests). -- all configuration switches should be documented - (check [filetype.txt][13] and/or [syntax.txt][14] for filetype and syntax plugins) -- add yourself as Maintainer to the top of the file (again, keep the header similar - to other runtime files) -- add yourself to the [MAINTAINERS][11] file. -- add a guard `if has('vim9script')` if you would like to maintain Neovim - compatibility but want to use Vim9 script (or restrict yourself to legacy Vim - script) - -# Translations - -Translating messages and runtime files is very much appreciated! These things -can be translated: - -- Messages in Vim, see [src/po/README.txt][1] - Also used for the desktop icons. -- Menus, see [runtime/lang/README.txt][2] -- Vim tutor, see [runtime/tutor/README.txt][3] -- Manual pages, see [runtime/doc/\*.1][4] for examples -- Installer, see [nsis/lang/README.txt][5] in the [vim-win32-installer][20] repository - -The help files can be translated and made available separately. -See https://www.vim.org/translations.php for examples. - -# How do I contribute to the project? - -Please have a look at the following [discussion][6], which should give you some -ideas. Please also check the [develop.txt][7] helpfile for the recommended -coding style. Often it's also beneficial to check the surrounding code for the style -being used. - -For the recommended documentation style, please check [helphelp.txt][16]. - -# I have a question - -If you have some question on the style guide, please contact the [vim-dev][0] -mailing list. For other questions you can join [`#vim`][19], use the -[Vi Stack Exchange][8] website, the [vim-use][9] mailing list or make use of the -[discussion][10] feature here at GitHub. - -[todo list]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt -[0]: http://www.vim.org/maillist.php#vim-dev -[1]: https://github.com/vim/vim/blob/master/src/po/README.txt -[2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt -[3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt -[4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1 -[5]: https://github.com/vim/vim-win32-installer/blob/master/nsis/lang/README.txt -[6]: https://github.com/vim/vim/discussions/13087 -[7]: https://github.com/vim/vim/blob/master/runtime/doc/develop.txt -[8]: https://vi.stackexchange.com -[9]: http://www.vim.org/maillist.php#vim-use -[10]: https://github.com/vim/vim/discussions -[11]: https://github.com/vim/vim/blob/master/.github/MAINTAINERS -[12]: https://github.com/vim/vim/blob/master/src/testdir/test_filetype.vim -[13]: https://github.com/vim/vim/blob/master/runtime/doc/filetype.txt -[14]: https://github.com/vim/vim/blob/master/runtime/doc/syntax.txt -[15]: https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin -[16]: https://github.com/vim/vim/blob/master/runtime/doc/helphelp.txt -[17]: https://github.com/vim/vim/issues -[19]: https://web.libera.chat/#vim -[20]: https://github.com/vim/vim-win32-installer