Code standards - crccheck/crccheck.github.io GitHub Wiki

Integration tests should clean up after themselves

Errors

Error logs and above should only be emitted for actual errors. If your application regularly puts out error logs and nothing is wrong, you're using logs wrong.

Use custom errors

REST APIs

• Always return statusCode. Don't assume clients will have access to HTTP headers or status
• Similarity, return data nested in data. Don't assume clients will have access to HTTP headers or status
• POST and PUT requests should have the same response body as the equivalent GET (If it's reasonable that a user would immediately run GET. don't make them have to do that)

Reading

• https://jsonapi.org/ is a useful reference, but don't follow it. It doesn't create elegant APIs and it's a pain. Maybe if you're a big company with $$$ to spend