Skip to content

Latest commit

 

History

History
166 lines (123 loc) · 7.66 KB

CONTRIBUTING.md

File metadata and controls

166 lines (123 loc) · 7.66 KB
Raw

Contributing

Thank you for your willingness to contribute to 'mini.nvim'. It means a lot!

You can make contributions in the following ways:

  • Mention it somehow to help reach broader audience. This helps a lot.
  • Create a GitHub issue. It can be one of two types:
    • Bug report. Describe your actions in a reproducible way along with their effect and what you expected should happen. Before making one, please make your best efforts to make sure that it is not an intended behavior (not described in documentation as such).
    • Feature request. A concise and justified description of what one or several modules should be able to do. Before making one, please make your best efforts to make sure that it is not a feature that won't get implemented (these should be described in documentation; for example: block comments in 'mini.comment').
  • Create a pull request (PR). It can be one of two types:
    • Code related. For example, fix a bug or implement a feature. Before even starting one, please make sure that it is aligned with project vision and goals. The best way to do it is to receive a positive feedback from maintainer on your initiative in one of the GitHub issues (existing one or created by you otherwise). Please, make sure to regenerate latest help file and that all tests are passed (see later sections).
    • Add plugin integration to 'mini.base16' color scheme. See for checklist.
    • Documentation related. For example, fix typo/wording in 'README.md', code comments or annotations (which are used to generate Neovim documentation; see later section). Feel free to make these without creating a GitHub issue.
  • Add explicit support to colorschemes. Any 'mini.nvim' module supports any colorscheme right out of the box. This is done by making most highlight groups be linked to a semantically similar builtin highlight group. Other groups are hard-coded based on personal preference. However, these choices might be out of tune with a particular colorscheme. Updating as many colorschemes as possible to have explicit 'mini.nvim' support is highly appreciated. For your convenience, there is a list of all highlight groups in later section of this file.
  • Participate in discussions.

All well-intentioned, polite, and respectful contributions are always welcome! Thanks for reading this!

Commit messages

  • Try to make commit message as concise as possible while giving enough information about nature of a change. Think about whether it will be easy to understand in one year time when browsing through commit history.

  • Use two part structure:

    • First part is a change overview in present tense, preferably in single line under 80 characters. Should end with a period. Usually should be enough.

      If commit affects only one particular module (as it usually should), prepend with "(mini.<module-name>) ". If commit ensures something for all modules but not necessary touches all of them, use "(all) ".

    • Second part is optional and should contain details about the change after empty line and "Details:". Use bullet list with -.

      Use "Resolves #xxx" as separate entry if this commit resolves issue or PR.

  • Use these prefixes after initial module name in described situations:

    • "FEATURE:" - if change implements new feature (like option or function).
    • "BREAKING:" - if change breaks current documented behavior.
    • "BREAKING FEATURE:" - if change introduces new feature while breaking current documented behavior.
    • "NEW MODULE:" - if change introduces new module (see 'MAINTAINING.md').

  • Use module's function and field names without module's name. Like add() and not MiniSurround.add().

Examples:

Fix typo in 'README.md'.

(mini.animate) Update `cursor` to use virtual columns.

Details:
- Resolves #258.

(mini.comment) FEATURE: add `options.pad_comment_leaders` option.

Generating help file

If your contribution updates annotations used to generate help file, please regenerate it. You can make this with one of the following (assuming current directory being project root):

  • From command line execute make documentation.
  • Inside Neovim instance run :luafile scripts/minidoc.lua.

Running tests

If your contribution updates code and you use Linux (not Windows or MacOS), please make sure that it doesn't break existing tests. If it adds new functionality or fixes a recognized bug, add new test case(s). There are two ways of running tests:

  • From command line execute make test to run all tests or FILE=<name of file> make test_file to run tests only from file <name of file>.
  • Inside Neovim instance execute :lua require('mini.test').setup(); MiniTest.run() to run all tests or :lua require('mini.test').setup(); MiniTest.run_file() to run tests only from current buffer.

This plugin uses 'mini.test' to manage its tests. For more hands-on introduction, see TESTING.md.

If you have Windows or MacOS and want to contribute code related change, make you best effort to not break existing behavior. It will later be tested automatically after making Pull Request. The reason for this distinction is that tests are not well designed to be run on those operating systems.

Formatting

This project uses StyLua version 0.14.0 for formatting Lua code. Before making changes to code, please:

  • Install StyLua. NOTE: use v0.14.0.
  • Format with it. Currently there are two ways to do this:
    • Manually run stylua . from the root directory of this project.
    • Install pre-commit and enable it with pre-commit install (from the root directory). This will auto-format relevant code before making commits.

List of highlight groups

Here is a list of all highlight groups defined inside 'mini.nvim' modules. See documentation in 'doc' directory to find out what they are used for.

  • 'mini.animate':

    • MiniAnimateCursor
    • MiniAnimateNormalFloat

  • 'mini.completion':

    • MiniCompletionActiveParameter

  • 'mini.cursorword':

    • MiniCursorword
    • MiniCursorwordCurrent

  • 'mini.hipatterns':

    • MiniHipatternsFixme
    • MiniHipatternsHack
    • MiniHipatternsNote
    • MiniHipatternsTodo

  • 'mini.indentscope':

    • MiniIndentscopeSymbol
    • MiniIndentscopeSymbolOff

  • 'mini.jump':

    • MiniJump

  • 'mini.jump2d':

    • MiniJump2dDim
    • MiniJump2dSpot
    • MiniJump2dSpotAhead
    • MiniJump2dSpotUnique

  • 'mini.map':

    • MiniMapNormal
    • MiniMapSymbolCount
    • MiniMapSymbolLine
    • MiniMapSymbolView

  • 'mini.starter':

    • MiniStarterCurrent
    • MiniStarterFooter
    • MiniStarterHeader
    • MiniStarterInactive
    • MiniStarterItem
    • MiniStarterItemBullet
    • MiniStarterItemPrefix
    • MiniStarterSection
    • MiniStarterQuery

  • 'mini.statusline':

    • MiniStatuslineDevinfo
    • MiniStatuslineFileinfo
    • MiniStatuslineFilename
    • MiniStatuslineInactive
    • MiniStatuslineModeCommand
    • MiniStatuslineModeInsert
    • MiniStatuslineModeNormal
    • MiniStatuslineModeOther
    • MiniStatuslineModeReplace
    • MiniStatuslineModeVisual

  • 'mini.surround':

    • MiniSurround

  • 'mini.tabline':

    • MiniTablineCurrent
    • MiniTablineFill
    • MiniTablineHidden
    • MiniTablineModifiedCurrent
    • MiniTablineModifiedHidden
    • MiniTablineModifiedVisible
    • MiniTablineTabpagesection
    • MiniTablineVisible

  • 'mini.test':

    • MiniTestEmphasis
    • MiniTestFail
    • MiniTestPass

  • 'mini.trailspace':

    • MiniTrailspace