Coldfire
Coldfire copied to clipboard
Code improvements
TODO:
- [ ] error propagation
- [ ] logging errors
- [ ] documentation string over exported functions
- [ ] documentation string on package
As listed in the TODO list above, some of the parts of code are inconsistent.
- You should consider using tools like
go vet,go fmtandgo imports. - Unexported methods should be used.
- Exported methods should contain doc comment.
- If this is module/library/framework, then you shouldn't log inside the functions, but return errors with additional info.
- If some part of code should run, and fail if error occurs, name function according to the scheme
MustDoSomethin()and thenpanicon error. Note that in doc comment.