Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (47 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

61 lines (47 loc) · 1.34 KB

Contributing

Contributions are welcome! You will find here a set of guidelines for you.

Guidelines

Important

For step No.3 please format your plugins following the Conventional Commits Specification!

  1. Fork the repository
  2. Create a feature branch:
git checkout -b feature/amazing-feature
  1. Add then commit your changes:
git commit -m 'feat(scope): add amazing feature' # USE Conventional Commits PLEASE
  1. Push to the branch:
git push origin feature/amazing-feature
  1. Open a Pull Request

Development

lazy.nvim

If you're using lazy.nvim you can clone your fork in a selected directory, then set the dev = true option in your installation:

require('lazy').setup({
  spec = {
    -- ...
    {
      'gisketch/triforce.nvim',
      dev = true, --- Flag needed!
      dependencies = { 'nvzone/volt' },
      config = function()
        require('triforce').setup()
      end,
    },
  },

  -- ...

  dev = { path = '/path/to/directory' },
})

With Symlinks

git clone https://github.com/gisketch/triforce.nvim.git # Clone the repo
ln -s "$(pwd)/triforce.nvim" ~/.local/share/nvim/site/pack/plugins/start/triforce.nvim # Symlink to Neovim config for testing