Skip to content

Conversation

@packtman
Copy link

Issue Reference #1745

Summary

Added a comprehensive "How To Make A Cheatsheet" guide to help contributors create effective security cheat sheets.

Changes Made

  • Created GUIDELINE.md with detailed guidance for cheat sheet creation
  • Updated README.md to reference the new guide
  • Updated CONTRIBUTING.md to reference the new guide

Benefits

  • Helps new contributors understand how to create quality cheat sheets
  • Provides comprehensive best practices and templates
  • Improves the contribution experience for the community

jmanico
jmanico previously approved these changes Aug 26, 2025
Copy link
Member

@jmanico jmanico left a comment

Choose a reason for hiding this comment

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

Excellent!

@jmanico
Copy link
Member

jmanico commented Aug 26, 2025

There are several lint errors, for example:

GUIDELINE.md:1 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# Cheat Sheet Creation Guide"]
GUIDELINE.md:2 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "## How to Create Comprehensive Security Cheat Sheets"]
GUIDELINE.md:9:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
GUIDELINE.md:47 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Developers: Code examples, i..."]
GUIDELINE.md:53 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Beginner: Basic concepts, st..."]
GUIDELINE.md:61 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Existing Coverage: Check..."]
GUIDELINE.md:85 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Comprehensive Coverage: 3,00..."]
GUIDELINE.md:91 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Background & Theory: 20%"]
GUIDELINE.md:118 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "1. Background & Context"]
GUIDELINE.md:119 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem statement"]
GUIDELINE.md:123 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "2. Threat Analysis"]
GUIDELINE.md:124 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Attack vectors"]
GUIDELINE.md:128 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "3. Prevention Strategies"]
GUIDELINE.md:129 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Defense in depth approach"]
GUIDELINE.md:133 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "4. Implementation Guide"]
GUIDELINE.md:134 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Step-by-step instructions"]
GUIDELINE.md:138 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "5. Testing & Validation"]
GUIDELINE.md:139 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Verification methods"]
GUIDELINE.md:143 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "6. Monitoring & Maintenance"]
GUIDELINE.md:144 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Ongoing security measures"]
GUIDELINE.md:148 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "7. References & Resources"]
GUIDELINE.md:149 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Further reading"]
GUIDELINE.md:158 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Hierarchical Structure: Use ..."]
GUIDELINE.md:164 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Clear & Descriptive: Section..."]
GUIDELINE.md:172 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Related Cheat Sheets: Links ..."]
GUIDELINE.md:178 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "markdown"] GUIDELINE.md:193 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Clear Language: Avoid unnece..."] GUIDELINE.md:209 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Code examples in multiple la..."] GUIDELINE.md:215 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Threat analysis and risk ass..."] GUIDELINE.md:221 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- System-level security consid..."] GUIDELINE.md:227 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Deployment and configuration..."] GUIDELINE.md:246 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem-Solution: Identify p..."] GUIDELINE.md:272 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "java"]
GUIDELINE.md:279 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Language-Specific: Provide e..."]
GUIDELINE.md:302 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "nginx"] GUIDELINE.md:313 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Flow Diagrams: Attack vector..."] GUIDELINE.md:319 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Clear & Simple: Avoid overly..."] GUIDELINE.md:329 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Problem Statement: What sec..."] GUIDELINE.md:337 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "markdown"]
GUIDELINE.md:364 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Network Layer: Network-leve..."]
GUIDELINE.md:370 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "markdown"] GUIDELINE.md:397 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Design Phase: Security cons..."] GUIDELINE.md:542 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Security Experts: Validate s..."] GUIDELINE.md:548 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Initial Review: Technical a..."] GUIDELINE.md:556 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Technical Writers: Review cl..."] GUIDELINE.md:562 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Technical Accuracy: All info..."] GUIDELINE.md:572 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Functionality: Code examples..."] GUIDELINE.md:578 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Unit Testing: Test individu..."] GUIDELINE.md:586 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Comprehension: Target audien..."] GUIDELINE.md:592 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- User Testing: Have target us..."] GUIDELINE.md:615 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- New Vulnerabilities: Update ..."] GUIDELINE.md:621 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Critical: Security vulnerabi..."] GUIDELINE.md:645 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- What Changed: Document speci..."] GUIDELINE.md:651 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Content Updates: New informa..."] GUIDELINE.md:661 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- User Surveys: Regular feedba..."] GUIDELINE.md:667 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Content Quality: Accuracy, c..."] GUIDELINE.md:675 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Content Gaps: Identify missi..."] GUIDELINE.md:681 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Identify Opportunities: Gat..."] GUIDELINE.md:863 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 7.2 Advanced Template Features"] GUIDELINE.md:864 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "markdown"]
GUIDELINE.md:945 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Further Reading"]
GUIDELINE.md:946 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [OWASP Cheat Sheets Series](..."]
GUIDELINE.md:950 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Tools & Templates"]
GUIDELINE.md:951 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [Markdown Guide](https://www.../"]
GUIDELINE.md:955 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Community"]
GUIDELINE.md:956 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [OWASP Community](https://ow.../"]
GUIDELINE.md:961:142 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

@packtman
Copy link
Author

Will fix the errors this weekend 👍

jmanico
jmanico previously approved these changes Sep 1, 2025
@jmanico
Copy link
Member

jmanico commented Sep 1, 2025

A few more still exist : GUIDELINE.md:124 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "1. Background & Context"]
GUIDELINE.md:130 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "2. Threat Analysis"]
GUIDELINE.md:136 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "3. Prevention Strategies"]
GUIDELINE.md:142 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "4. Implementation Guide"]
GUIDELINE.md:148 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "5. Testing & Validation"]
GUIDELINE.md:154 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "6. Monitoring & Maintenance"]
GUIDELINE.md:160 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "7. References & Resources"]
GUIDELINE.md:295 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "java"] GUIDELINE.md:326 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "nginx"]
GUIDELINE.md:912 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [Related Cheat Sheet 3](link..."]
GUIDELINE.md:913 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
GUIDELINE.md:1017:142 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
Error: Process completed with exit code 1.

@jmanico
Copy link
Member

jmanico commented Sep 5, 2025

One markdown bug left!

GUIDELINE.md:295 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```java"]

GUIDELINE.md Outdated
- Functionality: Code examples work as intended
- Security: Examples implement security best practices
- Compatibility: Examples work across different environments
- Performance: Examples don't introduce performance issues
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO remove this

Copy link
Author

Choose a reason for hiding this comment

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

Just the performance part of Testing criteria section?

Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO only Performance

GUIDELINE.md Outdated
1. Unit Testing: Test individual code examples
2. Integration Testing: Test examples in context
3. Security Testing: Verify security properties
4. Performance Testing: Check for performance impact
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO remove this

Copy link
Author

@packtman packtman Sep 13, 2025

Choose a reason for hiding this comment

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

Just the performance part of Testing process section?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes the performance section does not apply to this project

GUIDELINE.md Outdated
---
## Maintenance & Updates
Copy link
Collaborator

Choose a reason for hiding this comment

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

This does not match what we or contributors do

Copy link
Author

Choose a reason for hiding this comment

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

Just wanted to confirm, you want me to remove entire section and directly go to section 7.

Copy link
Author

Choose a reason for hiding this comment

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

@mackowski bump on the comments and new commit review

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, the whole section should be removed

@jmanico
Copy link
Member

jmanico commented Sep 11, 2025 via email

@packtman
Copy link
Author

Just noticed the linters fix led to a bit messed up previous section 7, now section 6. I need to fix section 6 and check if I get new linter related issues.

@jmanico
Copy link
Member

jmanico commented Sep 18, 2025

@mackowski has the lead here, let's patiently wait for his review :)

GUIDELINE.md Outdated
- Functionality: Code examples work as intended
- Security: Examples implement security best practices
- Compatibility: Examples work across different environments
- Performance: Examples don't introduce performance issues
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO only Performance

GUIDELINE.md Outdated
```
### 6.2 Advanced Template Features
Copy link
Collaborator

Choose a reason for hiding this comment

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

was this all tested? Is it working in markdown and on the website?

GUIDELINE.md Outdated
## Additional Resources
### Further Reading
Copy link
Collaborator

Choose a reason for hiding this comment

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

This further reading is not helpful in this context right?

GUIDELINE.md Outdated
- [GitHub Markdown](https://docs.github.com/en/github/writing-on-github)
- [MkDocs Documentation](https://www.mkdocs.org/)
### Community
Copy link
Collaborator

Choose a reason for hiding this comment

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

What is the benefit of having this here?

Copy link
Author

Choose a reason for hiding this comment

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

let me remove the whole additional resources section.

Copy link
Author

Choose a reason for hiding this comment

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

Unless, we want to embed a section dedicated for adding owasp channels or route users to contributors and chat with them.

@mackowski
Copy link
Collaborator

I left some comments + Markdown linter is failing + I would like to see an example of at least one cheatsheet created (by human or LLM + human) based on this guide to see what is essential in this guide and what is not needed.
I feel that this guide is lengthly

@packtman
Copy link
Author

packtman commented Oct 2, 2025

I left some comments + Markdown linter is failing + I would like to see an example of at least one cheatsheet created (by human or LLM + human) based on this guide to see what is essential in this guide and what is not needed. I feel that this guide is lengthly

You may look at what MCP Cheatsheet team is doing here https://docs.google.com/document/d/16LvkpUOC5arYl1uIjBglIg9UhoOKm1Lsb6OJYUJhfPU/edit?tab=t.1hsjuwcid34z#heading=h.i6wuwte0l3gd

Do you want to recommend any other new cheatsheet who can leverage what we have suggested in this PR?

GUIDELINE.md Outdated

Recommended Content Length:

- Comprehensive Coverage: 3,000-5,000 lines of content
Copy link
Collaborator

Choose a reason for hiding this comment

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

We do not want so long cheatsheets

Copy link
Author

Choose a reason for hiding this comment

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

agreed, let me remove it.

GUIDELINE.md Outdated
Recommended Content Length:

- Comprehensive Coverage: 3,000-5,000 lines of content
- Practical Examples: 20-30 code samples per cheat sheet
Copy link
Collaborator

Choose a reason for hiding this comment

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

From where you get this number?

GUIDELINE.md Outdated

- Comprehensive Coverage: 3,000-5,000 lines of content
- Practical Examples: 20-30 code samples per cheat sheet
- Multiple Perspectives: 3-5 different approaches/methodologies
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you give an example of 3-5 cheatsheets that are doing that

GUIDELINE.md Outdated
- Comprehensive Coverage: 3,000-5,000 lines of content
- Practical Examples: 20-30 code samples per cheat sheet
- Multiple Perspectives: 3-5 different approaches/methodologies
- Cross-References: 10-15 links to related topics
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is too much

@szh
Copy link
Collaborator

szh commented Oct 3, 2025

I think the general gist of this cheat sheet is just too much. Cheat sheets aren't comprehensive guides, and we certainly don't want an extremely long document explaining how to write them.

@packtman
Copy link
Author

packtman commented Oct 3, 2025

I think the general gist of this cheat sheet is just too much. Cheat sheets aren't comprehensive guides, and we certainly don't want an extremely long document explaining how to write them.

I agree, how about we just keep Section 6 template? Let's keep it simple to start with.

Just keep this section

6.1 Basic Cheat Sheet Template

I think this is the core and the most useful part. I can delete rest. Thoughts @mackowski @szh @jmanico?

@szh
Copy link
Collaborator

szh commented Oct 3, 2025

I love that idea

CONTRIBUTING.md Outdated

### Structure

> **Need help with content structure?** Check out our comprehensive [How To Make A Cheatsheet guide](GUIDELINE.md) for detailed structure guidelines, content organization, and best practices.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this should say something like "Check out our template" or just "Check out our guidelines" now that it's not comprehensive.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Still needs to be addressed

GUIDELINE.md Outdated
@@ -0,0 +1,260 @@
# Cheat Sheet Creation Guide

## How to Create Comprehensive Security Cheat Sheets
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd remove "Comprehensive". That's not what we want in a cheat sheet.

GUIDELINE.md Outdated
Comment on lines 7 to 13
## Executive Summary

This guide provides a comprehensive framework for creating high-quality security cheat sheets based on analysis of 100+ OWASP cheat sheets. It covers structure, content, formatting, and best practices for creating authoritative security guidance documents.

**Target Audience**: Security professionals, developers, technical writers, and anyone creating security documentation.

**Based On**: Analysis of 100+ OWASP cheat sheets ranging from 44KB to 212KB in size.
Copy link
Collaborator

Choose a reason for hiding this comment

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

For brevity I'd honestly remove this whole section

GUIDELINE.md Outdated

## Conclusion

Creating comprehensive security cheat sheets requires careful planning, thorough research, and ongoing maintenance. By following this guide, you can create authoritative, practical, and valuable security guidance that helps practitioners implement effective security controls.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This sounds too mellow and AI generated. I don't think it's necessarily bad, just very non-human.

Copy link
Author

Choose a reason for hiding this comment

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

Ack, let me make changes to this language.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Still needs to be addressed

GUIDELINE.md Outdated
---


*This guide is based on analysis of 100+ OWASP cheat sheets and represents best practices for creating comprehensive security documentation.*
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you share more details on how this analysis was performed and how it was used to generate these recommendations?

Copy link
Author

Choose a reason for hiding this comment

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

Sure, I downloaded all the cheatsheets and ran an analysis on it using Cursor. Looked for common patterns and gaps and provided template based on this analysis. Comment for reference #1745 (comment)

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would love more details on what the analysis was. Like what prompts were used, etc. if you still have.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @szh, I had created this document when I worked on analysis of Threat Modeling Analysis for 100+ threat models https://docs.google.com/document/d/1RkpBgLICnTbpPQLeIxc7njzQC3ULhAHH/edit

Unfortunately, I didn't document something similar for this guideline analysis. Let me know if this gives you a good idea of how the analysis was performed.

GUIDELINE.md Outdated

### Remember

The goal is to create **practical, actionable security guidance** that helps practitioners build more secure applications and systems. Focus on providing value to your target audience and maintaining high quality standards.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should mention "concise" somewhere

README.md Outdated
## Contributions, Feature Requests, and Feedback

We are actively inviting new contributors! To start, please read the [contribution guide](CONTRIBUTING.md).
We are actively inviting new contributors! To start, please read the [contribution guide](CONTRIBUTING.md) and our comprehensive [How To Make A Cheatsheet guide](GUIDELINE.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
We are actively inviting new contributors! To start, please read the [contribution guide](CONTRIBUTING.md) and our comprehensive [How To Make A Cheatsheet guide](GUIDELINE.md).
We are actively inviting new contributors! To start, please read the [contribution guide](CONTRIBUTING.md) and our [How To Make A Cheatsheet guide](GUIDELINE.md).

@packtman
Copy link
Author

packtman commented Oct 3, 2025

Alright, this is much cleaner and simpler to consume. Please let me know if I need to make any other changes.

@szh
Copy link
Collaborator

szh commented Oct 3, 2025

@packtman Getting closer! I left a few more comments

@packtman
Copy link
Author

packtman commented Oct 3, 2025

@packtman Getting closer! I left a few more comments

Done, let me know if this looks good now.

@jmanico
Copy link
Member

jmanico commented Oct 8, 2025

Thank you @szh and @mackowski for taking "lead review" roles on this. I support whatever decisions you both agree to.

Any thank you to everyone else for working on this!

@packtman
Copy link
Author

Hey everyone, please let me know if the changes look good.

szh
szh previously approved these changes Oct 17, 2025
Copy link
Collaborator

@szh szh left a comment

Choose a reason for hiding this comment

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

LGTM

@szh
Copy link
Collaborator

szh commented Oct 17, 2025

Oops, I missed that the linter is failing:

GUIDELINE.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
GUIDELINE.md:245 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

Copy link
Collaborator

@szh szh left a comment

Choose a reason for hiding this comment

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

LGTM. @mackowski will need your approval as well

Copy link

@andrzejsydor andrzejsydor left a comment

Choose a reason for hiding this comment

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

not needed such a change

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.

5 participants