rust-bitcoin / rust-bitcoin/rust-bitcoin
Add a STYLE.md guide for contributors and LLMs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.7k
- Forks
- 1k
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 88
Description
Do you think you could write down these rules in a STYLE.md file or something that we could just feed to a LLM?
Originally posted by @apoelstra in https://github.com/rust-bitcoin/rust-bitcoin/pull/6232#discussion_r3306258955
@tcharding as the holder of all style and idiom knowledge, would this be useful?
A solution could instead be to expand on the coding conventions in CONTRIBUTING.md, or factor that stuff out into a STYLE.md.
Anyway, just leaving it here so it doesn't get lost.
Contributor 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.
Research direction
Start with the coding conventions section of CONTRIBUTING.md and review the discussion linked from the issue. Decide whether the guidance belongs in CONTRIBUTING.md or a new STYLE.md, then document the contributor and LLM-facing style and idiom rules agreed on by the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100