CONTRIBUTING.md

Contributing to Relative Toggle

Thank you for investing your time in contributing to our project!

One of the best ways to begin contributing in a meaningful way is by helping find bugs and filing issues for them.

Issues

Issues are very valuable to this project.

• Ideas are a valuable source of contributions others can make.
• Problems show where this project is lacking.
• With a question, you show where contributors can improve the user experience.

Thank you for creating them.

Pull requests

1. Fork your own copy of this project.
2. Clone and link your fork with this repository git remote add upstream https://github.com/cpea2506/relative-toggle.nvim.git.
3. You can now git fetch upstream and git rebase [-i] upstream/main to update your branches with the latest contributions.

Setting up development tools

1. Formatter: Stylua
2. Linter: Selene
3. Make

Code conventions

• All lua code must be formatted with Stylua to make consistence over project.

  # configurations are already stored in .stylua.toml
  stylua -c .

• Make sure Selene do not scream at you even with Warning ⚠️

  # configuration are already stored in selene.toml and neovim.yml
  selene .

Start developing

• Use a git-feature-branch instead of the main branch.

• Use a rebase-workflow.

• Name your branches meaningfully. Ex: (feat/docs/...)/<what-your-pr-does>

• Make sure all the tests pass locally before pushing with make test command. Ex output:

  $ make test
  nvim --headless --noplugin -u tests/minimal_init.lua +Test
  Starting...Scheduling: tests/spec/config_spec.lua
  
  ========================================
  Testing:        relative-toggle.nvim/tests/spec/config_spec.lua
  Success ||      Override config should change default config
  Success ||      Override config should log error
  
  Success:        2
  Failed :        0
  Errors :        0
  ========================================

Open PRs

• Title of the PR must follow commit convention
• Your PR must pass all the workflows.