NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-30 00:26:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: wording

Browse source
This commit is contained in:
raf 2023-07-24 08:18:19 +03:00
parent 9e23ff355e
commit 48219eba74
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
.github/CONTRIBUTING.md vendored
View file

@ -32,11 +32,10 @@ Here are the overall boundaries I would like you to follow while contributing to
If you are making a pull request to add a
#### Style
**Nix**
We use Alejandra for formatting nix code, which can be invoked directly with `nix fmt` in the repository.
We use Alejandra for formatting nix code, which can be invoked directly by running `nix fmt` in the repository.
While Alejandra is mostly opinionated on how code looks after formatting, certain formattings are done at the user's discretion.
@ -71,6 +70,7 @@ module = {
```
For lists, it's up mostly to your discretion but please try to avoid unfolded lists if there is only one item in the list.
```nix
# ok
@ -85,7 +85,8 @@ acceptableList = [
listToBeAvoided = [item1 item2 item3 item4];
```
*This will be moved elsewhere, disregard unless you are adding a new plugin with keybinds*
_This will be moved elsewhere, disregard unless you are adding a new plugin with keybinds_
#### Keybinds
##### Custom key mappings support for a plugin
@ -237,5 +238,3 @@ in {
```
If you have come across a plugin that has an API that doesn't seem to easily allow custom keybindings, don't be scared to implement a draft PR. We'll help you get it done.