Contributor guide

Contribute in one focused PR

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

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

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.

Good contribution ideas

  • Improve correctness: fact-check claims and remove outdated or incorrect details.
  • 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.

  • new-post +50
  • translation +30
  • new-example +20
  • fact-check +15
  • source-added +10
  • typo +5

Highest value label right now: 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).