rocq-prover / rocq-prover/platform-docs

How not to never need more than three bullets

Open
#59 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Help Wanted Wish
Dominant language
Rocq Prover
Stars
26
Forks
25
Avg merge
2d 22h
Merged PRs (30d)
1

Description

A how-to guide explaining how to keep the code, and never to need more than three bullets

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no documentation file, example, or entry point. First clarify what coding practice the guide should explain and where it belongs, then draft a how-to guide that explains how to keep the code concise and avoid needing more than three bullets; done means the guide is focused and actionable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.