jeremy/callisto
1
Fork 0
Code Releases Activity

style.md: revise

Browse source
This commit is contained in:
Jeremy Baxter 2024-02-27 18:29:26 +13:00
parent d21cceb014
commit e51e7fb95e
1 changed files with 15 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

28
style.md
View file

@ -1,4 +1,4 @@
## Callisto code style ## code style in Callisto
C, Lua and makefile code should use tabs for indentation; this allows C, Lua and makefile code should use tabs for indentation; this allows
one to set their own tab width preference in their editor. However, one to set their own tab width preference in their editor. However,
@ -11,24 +11,26 @@ C code in Callisto should follow the OpenBSD style(9) document:
Code in the Nix flake should follow the nixpkgs style guide: Code in the Nix flake should follow the nixpkgs style guide:
- https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#code-conventions - https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#code-conventions
## Commits ## commits
Prepend your commit message with the name of the Lua library that your Prepend your commit message with the name of the Lua library that your
commit primarily changes, for example if I were to add a new function commit primarily changes, for example if I were to add a new function
named `copy` to the `fs` library, I might use the commit message named `copy` to the `fs` library, I might use the commit message
"fs: add new function 'copy'". "fs: add new function 'copy'".
If the commit does not change code part of a Lua library but still
changes code, pick a prefix relevant to the code you changed, If the commit does not change code part of a Lua library,
e.g. "tests: add test for fs.copy", "makefile: fix build on NetBSD", prefix it with the area of the source tree you changed, e.g.:
"flake: remove darwin from platforms". - tests: add test for fs.copy
If the commit does not change code at all scrap the prefix. - makefile: fix build on NetBSD
- flake: remove darwin from platforms
Additionally follow these conventions taken from nixpkgs: Additionally follow these conventions taken from nixpkgs:
- Create a commit for each logical unit. - Create a commit for each logical unit.
- Check for unnecessary whitespace with `git diff --check` before
- Check for unnecessary whitespace with `git diff --check` before committing. committing.
- If you have commits `pkg-name: oh, forgot to insert whitespace`:
- If you have commits `pkg-name: oh, forgot to insert whitespace`: squash commits in this case. Use `git rebase -i`. squash commits in this case. Use `git rebase -i`.
- For consistency, there should not be a period at the end of the
- For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message). commit message's summary line (the first line of the commit
message).