Skip to content

Start documenting error handling in coding guidelines#50

Draft
rousskov wants to merge 12 commits into
squid-cache:mainfrom
measurement-factory:SQUID-111-error-reporting-guidelines
Draft

Start documenting error handling in coding guidelines#50
rousskov wants to merge 12 commits into
squid-cache:mainfrom
measurement-factory:SQUID-111-error-reporting-guidelines

Conversation

@rousskov

Copy link
Copy Markdown
Contributor

No description provided.

@rousskov rousskov marked this pull request as draft July 13, 2026 00:46
@rousskov

Copy link
Copy Markdown
Contributor Author

Marking as a draft because I do not know how to test how this markup is going to be rendered on the web site.

@rousskov

Copy link
Copy Markdown
Contributor Author

Several key decisions in these proposed guidelines were driven by unofficial notes at https://github.com/measurement-factory/squid-notes/blob/start/errors.md

@kinkie

kinkie commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

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?

@rousskov

Copy link
Copy Markdown
Contributor Author

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.

@rousskov rousskov removed the request for review from kinkie July 14, 2026 14:50
Co-authored-by: Francesco Chemolli <kinkie@squid-cache.org>
@rousskov rousskov changed the title Start documenting error handling in SquidCodingGuidelines Start documenting error handling in coding guidelines Jul 14, 2026
@rousskov

Copy link
Copy Markdown
Contributor Author

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.

Done in 235f7b2. Still untested.

@rousskov rousskov requested a review from kinkie July 14, 2026 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants