DomacsVim

Development

why not ! We accept any contribution and help in different sectors and we do not consider any of them to be small or unimportant. The only way to participate in this project is not to write or change the code, but you can also raise your ideas and opinions about adding a new feature, logo, interior design and etc.

Structure

├── LICENSE ├── Makefile ├── README.md ├── bin │   └── domacsvim-cli-template.sh ├── config.example.lua ├── database │   └── * ├── init.lua ├── installer │   └── install.sh └── lua ├── bootstrap.lua ├── config │   ├── defaults.lua │   └── init.lua ├── core │   ├── autopairs.lua │   ├── bufferline.lua │   ├── cmp.lua │   ├── dap.lua │   ├── dashboard.lua │   ├── gitsigns.lua │   ├── init.lua │   ├── log.lua │   ├── mason.lua │   ├── nvimtree.lua │   ├── telescope.lua │   ├── terminal.lua │   ├── treesitter.lua │   └── whichkey.lua ├── help │   └── init.lua ├── icons.lua ├── keymappings │   ├── keymappings.lua │   └── manager.lua ├── lsp │   ├── defaults.lua │   ├── init.lua │   ├── luasnip.lua │   └── manager.lua ├── options.lua ├── plugins │   ├── manager.lua │   └── plugins.lua └── utils.lua 10 directories, 36 files

Get started

To getting started, it's better to create a symbolic link of the project :

ln -s ~/.local/share/domacsvim ~/projects/domacsvim

Then, Create a new git repository and add your remote.

git remote add dev "remote"

Setup tools

To run stylua follow this command.

make style

To run luacheck follow this command.

make lint

Commit Messages

Note : Commit header is limited to 72 characters.

<type>(<scope>?): <summary> │ │ │ │ │ └─> Present tense. 'add something...'(O) vs 'added something...'(X) │ │ Imperative mood. 'move cursor to...'(O) vs 'moves cursor to...'(X) │ │ Not capitalized. │ │ No period at the end. │ │ │ └─> Commit Scope is optional, but strongly recommended. │ Use lower case. │ 'plugin', 'file', or 'directory' name is suggested, but not limited. │ └─> Commit Type: build|ci|docs|feat|fix|perf|refactor|test
  • build : changes that affect the build system or external dependencies (example scopes: npm, pip, rg)
  • ci : changes to CI configuration files and scripts (example scopes: format, lint, issue_templates)
  • docs : changes to the documentation only
  • feat : new feature for the user
  • fix : bug fix
  • perf : performance improvement
  • refactor : code change that neither fixes a bug nor adds a feature
  • test : adding missing tests or correcting existing tests
  • chore : all the rest, including version bump for plugins

Communication