Start documenting error handling in coding guidelines#50
Conversation
---- Cherry-picked commit 2711584 from Francesco's coding-guidelines-error-reporting branch (PR 48)
---- Applied changes suggested by Amos for Francesco's coding-guidelines-error-reporting branch (PR 48).
Inspired by github.com/measurement-factory/squid-notes/blob/start/errors.md
|
Marking as a draft because I do not know how to test how this markup is going to be rendered on the web site. |
|
Several key decisions in these proposed guidelines were driven by unofficial notes at https://github.com/measurement-factory/squid-notes/blob/start/errors.md |
|
LGTM in level of detail and to drive AI; it feels a bit verbose to include in the main coding guidelines. Would it be sensible to move it to its own page? |
Yes, I think it would, with a couple of bullet points remaining in SquidCodingGuidelines, so that folks reading our guidelines can discover the essential requirements (and then find the details on a dedicated page). I will adjust this PR to implement your suggestion. |
Co-authored-by: Francesco Chemolli <kinkie@squid-cache.org>
Done in 235f7b2. Still untested. |
No description provided.