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

Fix readme: Http header syntax highlighting #163

Merged
merged 1 commit into from
Dec 30, 2024

Conversation

NickNiebling
Copy link
Contributor

@NickNiebling NickNiebling commented Dec 30, 2024

Rationale for this PR

This PR is a minor semantic fix to readme files of GitHub and NuGet, that adds syntax highlighting for http header code block.

Org (using plaintext):

 cache-control: max-age=31536000,private 
 content-security-policy: script-src 'self';object-src 'self';block-all-mixed-content;upgrade-insecure-requests; 
 cross-origin-resource-policy: same-origin 
 referrer-policy: no-referrer 
 strict-transport-security: max-age=31536000;includeSubDomains 
 x-content-type-options: nosniff 
 x-frame-options: DENY 
 x-permitted-cross-domain-policies: none; 
 x-xss-protection: 0 

Suggested (using http - and removing leading whitespace):

cache-control: max-age=31536000,private 
content-security-policy: script-src 'self';object-src 'self';block-all-mixed-content;upgrade-insecure-requests; 
cross-origin-resource-policy: same-origin 
referrer-policy: no-referrer 
strict-transport-security: max-age=31536000;includeSubDomains 
x-content-type-options: nosniff 
x-frame-options: DENY 
x-permitted-cross-domain-policies: none; 
x-xss-protection: 0 

PR Checklist
Feel free to either check the following items (by place an x inside of the square brackets) or by replacing the square brackets with a relevant emoji from the following list:

✅ to indicate that you have checked something off
❎ to indicate that you haven’t checked something off
❓ to indicate that something might not be relevant (writing tests for documentation changes, for instance)

Essential
These items are essential and must be completed for each commit. If they are not completed, the PR may not be accepted.

❓ I have added tests to the OwaspHeaders.Core.Tests project
❓ I have run the dotnet-format command and fixed any .editorconfig issues
❓ I have ensured that the code coverage has not dropped below 65%
❓ I have increased the version number in OwaspHeaders.Core.csproj (only relevant for code changes)

Optional
❓ I have documented the new feature in the docs directory

Any Other Information

No other information

…NuGet (changing from "plaintext" to "http", and removing whitespace indentation to make it valid syntax for proper highlighting)
@NickNiebling NickNiebling changed the title Adding syntax highlighting for http header code blocks in GitHub and NuGet --fix readme: Http header syntax highlighting Dec 30, 2024
@NickNiebling NickNiebling changed the title --fix readme: Http header syntax highlighting Fix readme: Http header syntax highlighting Dec 30, 2024
@GaProgMan GaProgMan assigned GaProgMan and NickNiebling and unassigned GaProgMan Dec 30, 2024
@GaProgMan GaProgMan self-requested a review December 30, 2024 23:36
@GaProgMan GaProgMan added the docs label Dec 30, 2024
Copy link
Owner

@GaProgMan GaProgMan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fantastic, thank you for this PR

@GaProgMan
Copy link
Owner

One thing to note is that the PR will start a build, which will fail, when I merge it. In this instance, I'm OK with the build failure, as I have a set of code changes coming up, and will fix the build with that PR (#164 )

@GaProgMan GaProgMan merged commit cc7b291 into GaProgMan:main Dec 30, 2024
@NickNiebling
Copy link
Contributor Author

One thing to note is that the PR will start a build, which will fail, when I merge it. In this instance, I'm OK with the build failure, as I have a set of code changes coming up, and will fix the build with that PR (#164 )

I'm in sorry about that. I honestly didn't touch any code and expected to edit readme on a stable build 🙈 at least I was honest about how little I verified the commit wasn't breaking 🤣

Happy new year - and thanks for the modern .NET show 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants