OpenBlog Collaborative writing for portfolio and reputation growth

Contributor guide

Contribute in one focused PR

OpenBlog grows through merged pull requests. Pick a post, improve one clear thing, and submit your update in public.

Small improvements count. Fixes, metadata updates, sources, examples, translations, and new posts are all eligible for points.

Open repository Browse posts Create Post PR See leaderboard

Choose your contribution path

Use one of these two routes based on what you want to change.

Path A Create a new post Open the dedicated create workspace, write markdown, and submit a PR directly. Path B Edit an existing post Browse posts, open your target post, then click Open quick edit workspace.

First PR in 5 steps

  1. Pick one post slug to improve (for example networking/how-dns-works).
  2. Edit or create /content/posts/<category>/<post>.md.
  3. Run the site locally and verify your changes render correctly.
  4. Open a PR with a short summary of what changed and why it is better.
  5. Maintainers review, apply scoring label(s), merge, and points are added automatically.

Post writing docs

Use these two guides before opening your PR.

Post .md structure and metadata guide General markdown standards

Metadata improvements on existing posts are scored for everyone, even if the post is not originally yours: +10 with the fix-metadata label.

Good contribution ideas

  • Improve correctness: fact-check claims and remove outdated or incorrect details.
  • Improve metadata: strengthen title, description, tags, or language info for better discoverability.
  • Add references: back key statements with trustworthy sources.
  • Make it clearer: rewrite confusing paragraphs and tighten explanations.
  • Add practical examples: include commands, diagrams, or concrete use cases.
  • Create new content: add a complete new post when the topic is missing.

PR checklist

  • Your change is in content/posts/<category>/<post>.md.
  • The PR description explains what improved and why.
  • You mention the changed slug(s) in the PR body.
  • You do not manually edit files in openblog/generated/.

Scoring labels

Points are taken from labels applied to merged PRs. If multiple labels are applied, points are summed.

  • Create new post +50
  • Add translation +30
  • Add practical example +20
  • Improve accuracy +15
  • Add references +10
  • Improve metadata +10
  • Fix typo +5

Highest value label right now: Create new post (+50 points)

Scoring rules

  • Only merged PRs are eligible for points.
  • At least one scoring label is required to generate an event.
  • If a PR has multiple scoring labels, all label points are summed.
  • Leaderboard rank is sorted by total points (desc), then accepted PR count (desc).