What is open-source-guidelines?

A set of contribution rules for a database-free blog that uses TypeScript and static page generation. It covers code style, documentation, testing, accessibility, and demo content.

Use it when adding or reviewing blog features, updating documentation, testing MDX content, checking responsive layouts, or preparing a pull request.

It gives contributors a shared way to change the project without adding unnecessary dependencies or breaking its existing design. It also clarifies what to check before submitting a change.

open-source-guidelines — Cursor rule by muzaffar640

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add rules/muzaffar640/commitpress/open-source-guidelines

Clone the repo

git clone --depth 1 https://github.com/muzaffar640/commitpress

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.

When invoked 972 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.00000	$0.00972
Opus 5	$0.00000	$0.00486
Sonnet 5	$0.00000	$0.00194
Haiku 4.5	$0.00000	$0.00097

Measured yesterday against content hash 4d3dd39930ad, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

open-source-guidelines scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/open-source-guidelines.mdc · 161 lines

How it starts

The opening of the file, as written. The whole thing — 161 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Open Source Contribution Guidelines

Project Philosophy

This is a database-free blog system that prioritizes:

Simplicity over complexity
Developer experience over feature bloat
Performance through static generation
Accessibility for all users

Contribution Standards

Code Quality

Follow existing code patterns in src/
Maintain TypeScript strict mode compliance
Write clear, self-documenting code
Add JSDoc comments for complex functions

Database-Free Principle

Never add database dependencies
Keep the "two-commit workflow" intact
File-based content management only
Static generation preferred over dynamic rendering

Documentation Requirements

Update README.md for major changes
Update CONTRIBUTING.md for process changes
Add comments for non-obvious code
Include examples in pull requests

Testing New Features

Before Submitting PR

Test locally with npm run dev
Verify build works with npm run build
Test with different MDX content
Check responsive design
Validate accessibility

Demo Content Guidelines

Keep existing demo posts as examples
Don't add personal content to the main branch
Demo posts should showcase different content types
Maintain professional, educational tone

File Structure Conventions

Component Organization

src/
├── app/
│   ├── content/          # Demo blog posts (.mdx files)
│   ├── blog/            # Blog-related pages
│   └── globals.css      # Global styles
├── components/          # Reusable React components
│   ├── ui/             # shadcn/ui components
│   ├── Blog/           # Blog-specific components
│   └── MDX/            # MDX-related components
├── utils/              # Utility functions
│   └── mdx.ts          # Core MDX processing logic
└── types/              # TypeScript type definitions

Naming Conventions

Components: PascalCase (e.g., BlogCard.tsx)
Files: kebab-case for pages (e.g., blog-post.tsx)
Utilities: camelCase (e.g., formatDate.ts)
Types: PascalCase with descriptive names

Read the full file on GitHub · 161 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

yesterday First seen · 161 lines · 0 tokens per session scan A 4d3dd39930ad

Subscribe to this mod's changes

open-source-guidelines is a cursor rule published in the GitHub repository muzaffar640/commitpress (7 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 972 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Code review Frontend Testing blog blogging-platform freelancer mdx nextjs nextjs-template

open-source-guidelines