varakh/upda
1
0
Fork 0
Code Issues 1 Pull requests 4 Releases 10 Packages 1 Activity Actions

Minor refactor tackling typos, overhauling README, adding hints about useful resources to README, and avoid any panic/Fatalf from services and init calls #noissue
Some checks failed
/ build (push) Has been cancelled
Details

Browse source
This commit is contained in:
Varakh 2024-06-03 21:14:05 +02:00
parent 09ed6b1e41
commit f9362525de
1 changed files with 1 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -27,8 +27,7 @@ Contributions are very welcome!
* Always abort handler chain with `AbortWithError` * Always abort handler chain with `AbortWithError`
* Utils can throw any error * Utils can throw any error
* Repositories, handlers and services should always properly return `error` including any `init`-like function ( * Repositories, handlers and services should always properly return `error` including any `init`-like function (
best best to avoid them and call in `newXXX`). **Do not abort with `Fatalf` or similar**
to avoid them and call in `newXXX`). **Do not abort with `Fatalf` or similar**
* `log.Fatalf` or `zap.L().Fatal` is allowed in `environment.go` or `app.go` * `log.Fatalf` or `zap.L().Fatal` is allowed in `environment.go` or `app.go`
* Look into the `_doc/` folder for [OpenAPI specification](./_doc/api.yaml) and a Postman Collection. * Look into the `_doc/` folder for [OpenAPI specification](./_doc/api.yaml) and a Postman Collection.
* Consider reading [Effective Go](https://go.dev/doc/effective_go) * Consider reading [Effective Go](https://go.dev/doc/effective_go)