Fix, placeholder image, api
Added a placeholder image, code style Fixed metadata missing issue More work on api
This commit is contained in:
parent
529d106351
commit
0e036b152b
8 changed files with 192 additions and 94 deletions
21
Code-Style.md
Normal file
21
Code-Style.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# Code style guide
|
||||
|
||||
## Go
|
||||
|
||||
- Use `gofmt`
|
||||
- `jsonapi` fields must use dasharised names
|
||||
(eg `some-field` instead of `some_field` or `someField`)
|
||||
- Function, struct and variable names must describe their purpose adequatly.
|
||||
Making them longer for that purpose is fine
|
||||
- Follow [https://go.dev/doc/effective_go]
|
||||
(which also happens to be convenient place to start learning Go)
|
||||
- Always use zerolog for console output. In http handlers,
|
||||
use `hlog.FromRequest` to get a logger instance prepared with a bunch of metadata
|
||||
- As Linstrom is both intended for active use as well as providing a learning resource,
|
||||
all functions and structs must be documented
|
||||
|
||||
## JS/TS
|
||||
|
||||
<!-- TODO: Fill this out -->
|
||||
|
||||
- Biome should do most of the work
|
Loading…
Add table
Add a link
Reference in a new issue