RMI / RMI/practices

How do we want to standardize our root-level documentation across (public) repos

Open
#52 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Very useful discussion thread with @mbarlow12 can be found here

In particular, with the rise of LLM-enhanced software development, especially in the open-source world, more and more of the .md documentation is meant to target (and improve) the results of tools like Claude.

At the same time, we still want documentation such as CONTRIBUTING.md, HACKING.md, CODE_OF_CONDUCT.md that is human-friendly and not overloaded with information.

This ticket serves as a discussion platform for determining the appropriate standard .md files to be found at the root-level of any given repo, and if it serves to have any additional separation for more comprehensive documentation targetting the robots

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

Start with the linked pull-request review discussion and inspect the root-level documentation files named in the issue, including CONTRIBUTING.md, HACKING.md, and CODE_OF_CONDUCT.md. Compare their human-facing purpose with the proposed documentation for tooling, then document an agreed standard for which files belong at repository root and where more comprehensive guidance should live.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.