Skip to content

docs: update contributing section with PR review process #5

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.

Sign up for GitHub

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

Merged
marc0der merged 1 commit into from
Aug 26, 2025
Merged

docs: update contributing section with PR review process #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ Like [Awesome Cursor rules](https://github.com/PatrickJS/awesome-cursorrules), e

# Contributing New Rules

To contribute new rules, use the template format in `prompts/00-rules-template.md`. Generate rules with a meta-prompt like:
To contribute new rules:

```
Please generate me a new rule formatted according to prompts/00-rules-template.md that summarises the principles of [topic/methodology] in under 200 lines.
```
1. Use the template format in `prompts/00-rules-template.md`. Generate rules with a meta-prompt like:
```
Please generate me a new rule formatted according to prompts/00-rules-template.md that summarises the principles of [topic/methodology] in under 200 lines.
```

This ensures consistent structure and keeps rules focused and actionable.
2. Submit a pull request with your new rule. All PRs require review from at least one code owner.

# Using as a Git Submodule

Expand Down