Skip to content

docs(readme): make first-contribution opportunities easy to find - #855

Merged
yeongseon merged 1 commit into
mainfrom
issue-854
Oct 26, 2026
Merged

yeongseon merged 1 commit into
mainfrom
issue-854

Conversation

@yeongseon

Copy link
Copy Markdown
Owner

Closes #854

Summary

Add a concise Contributing section to README.md that makes first-contribution opportunities discoverable.

Changes

  • New Contributing section before Disclaimer and License
  • Links to CONTRIBUTING.md (setup and workflows)
  • Links to live GitHub label filters for good first issue and help wanted
  • Explains distinction: good first issue is scoped for first-time contributors; help wanted welcomes general community help
  • Invites prospective contributors to comment before starting
  • Welcomes bug reports and documentation improvements

Validation

  • make docs ✓ Documentation builds cleanly
  • make format-check ✓ Markdown formatting consistent
  • No code behavior, CI gates, or release automation changes
  • CONTRIBUTING.md unchanged (remains the single source of truth)
  • Translated READMEs (README.ko.md, README.ja.md, README.zh-CN.md) remain untouched
  • Links verified: points to canonical relative path (CONTRIBUTING.md) and live GitHub label filters

Closes #854

Add a concise Contributing section to README.md that:
- Links to CONTRIBUTING.md for setup and workflows
- Distinguishes 'good first issue' (for first-time contributors) from 'help wanted' (general community contributions)
- Encourages prospective contributors to comment before starting
- Welcomes bug reports and documentation improvements
- Does not duplicate CONTRIBUTING.md or rewrite existing guides

The section appears before Disclaimer and License, keeping CONTRIBUTING.md as the single source of truth for setup and process details.

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
@yeongseon
yeongseon merged commit 4dc223e into main Oct 26, 2026
22 checks passed
@yeongseon
yeongseon deleted the issue-854 branch October 26, 2026 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): make first-contribution opportunities easy to find

1 participant