Contributing
Development Setup
- Clone / Fork the repo.
- Enter the dev shell:
nix develop - Create a branch from main
- Make changes.
- Create a commit (Please follow conventional commitlint)
- Push
- Open a PR.
Note
Flake is configured to auto-run Flake checks, and Lints.
–
Tip
Repo itself is configured to use
npitself.nviminside repo default shell, isnp.
Guidelines
- Project Oriented Development (POD): POD cannot be sacrificed under any condition. Contributions that pollute the user’s home directory or OS will not be merged. All configurations must remain project-specific and isolated.
- Keybindings: Keys must be grouped logically, prioritizing usability over traditional conventions. This may or may not align with standard traditions.
- Follow NixVim best practices.
- Keep presets minimal and focused.
- Update docs for any changes.
- Strictly follow No Pollution policy.
- Create Lint-free Contributions.