Contributing
Your contributions are always welcome!
Quick steps
- Create a new file in
patterns/using kebab-case. - Copy the template from
TEMPLATE.md. - Open a PR titled
Add: pattern-name.
Rules
- One pattern per PR.
- Keep the pattern concise (max ~200 lines) and backed by a public reference.
- Fill in front-matter:
title,status,category,tags, plusauthors,based_on,sourcewhen available. - Do not edit README sections between the AUTO-GENERATED markers.
docs/is generated bymake site_linkand should not be edited by hand.- Check spelling/grammar and remove trailing whitespace.
Optional local checks
make lint_front_matterpython scripts/build_readme.py
Just a gentle reminder: Try not to submit your own project. Instead, wait until someone finds it useful and submits it for you.