docs(onboarding): Author the missing README for the seed workspace member
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, rust
- Domain
- documentation
Research direction
Read bin/seed/Cargo.toml for the crate’s one-line description and inspect the existing READMEs for api, store, ingest and webhooks to match their style. Create bin/seed/README.md under 40 lines covering the demo data, idempotency and mainnet refusal, and link the relevant file under docs/. Preview the Markdown and run any command you document; done when the README covers those points and the requested formatting, lint and test checks pass.
Written by the indexing model from the issue text.
Description
Description
bin/seed has no README, unlike api, store, ingest and webhooks, so newcomers cannot tell what it is for.
Requirements and context
- Where:
bin/seed/README.md - Security: Follow
docs/threat-model.md; no secrets, tokens or personal data in code, logs, tests or commit messages. - Testing:
just fmt-check,just lintandjust testmust pass; add or update tests for the change. - Documentation: Update the nearest doc if behaviour changes; otherwise no doc change is needed.
Suggested execution
- Comment on this issue to claim it, then fork the repository and branch from
main. - Branch name:
git checkout -b docs/seed-readme
Implement changes
- Create a short README (under 40 lines) covering the demo data it creates, idempotency and the mainnet refusal.
- Copy the one-line description from the crate's
Cargo.toml. - Link the relevant file under
docs/.
Test and commit
- Preview the Markdown and run any command you document.
- Run
just fmt,just lintandjust testlocally before pushing (seeCONTRIBUTING.md). - Commit with a conventional message and keep the change small and focused.
Example commit message
docs(seed): add README
Guidelines
- Open the PR against
mainand link it withCloses #<this issue>. - Keep the diff focused on this issue; no unrelated refactors or formatting churn.
- One line per comment, no bloated code; follow patterns already used in the crate.
- Never commit secrets,
.envfiles or real keys; use public test vectors only. - CI (fmt, clippy
-D warnings, tests) must be green before requesting review. - Ask in the issue thread if anything is unclear before starting.
- Dominant language
- Rust
- Stars
- 0
- Forks
- 91
- Avg merge
- 5h 23m
- Merged PRs (30d)
- 4
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Octo-Protocol-org/Octo-Protocol
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
area/integration area/testing enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Octo-Protocol-org/Octo-Protocol#701 · 1 comment ·
All issues in Octo-Protocol-org/Octo-Protocol
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mongodb/kingfisher#588 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
bug rust
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 2 days
-
type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
franciscoBSalgueiro/en-croissant#1111 ·
Maintainers usually reply within 2 days
-
[bug] Toolchain versions from `.prototools` are not inherited when moon runs from a subdirectoryOpen
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day