RMI / RMI/practices

Maybe add to `maintainer.md` – "On any `lifecycle stable` repository Ensure that a minimum of 2 tech staff"

Open
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

After we close #6 and understand what a "stable" API means, we may want to add to our maintainer.md definition something along the lines of:
"On any {lifecycle stable OR production OR whatever that definition ends up being} repository, the maintainer must do their best to ensure that a minimum of 2 people on the tech team are able to use the code using the stated API".

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 by reading issue #6 to understand the proposed definition of a stable API, then review maintainer.md. The work is done when the repository lifecycle criterion and the requirement for at least two technically capable team members are agreed and accurately documented.

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.