Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor/use x debug headers #25

Merged
merged 2 commits into from
Feb 6, 2025
Merged

Refactor/use x debug headers #25

merged 2 commits into from
Feb 6, 2025

Conversation

snim2
Copy link
Contributor

@snim2 snim2 commented Feb 6, 2025

It is conventional to use X- as a prefix for non-standard HTTP headers, and this is quite common in WordPress applications, including cache handling applications.

The use of X- as a prefix is generally not recommended for new protocols, for reasons outlined here:

https://datatracker.ietf.org/doc/html/rfc6648

However, in this case we are not expecting the debug headers in this plugin to become a widely adopted convention, and using X- seems like the least surprising naming to use.

It is conventional to use "X-" as a prefix for non-
standard HTTP headers, and this is quite common in
WordPress applications, including cache handling applications.

The use of X- as a prefix is generally not recommended
for new protocols, for reasons outlined here:

https://datatracker.ietf.org/doc/html/rfc6648

However, in this case we are not expecting the debug
headers in this plugin to become a widely adopted
convention, and using X- seems like the least surprising
naming to use.
@snim2 snim2 force-pushed the refactor/use-x-debug-headers branch from 2bd25ed to b65486c Compare February 6, 2025 15:47
@snim2 snim2 marked this pull request as ready for review February 6, 2025 15:47
@snim2
Copy link
Contributor Author

snim2 commented Feb 6, 2025

@RobjS I just realised I should have noted a breaking change int he ChangeLog...

@snim2 snim2 merged commit ff0eb2e into main Feb 6, 2025
2 checks passed
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.

2 participants