Define `documentation.md` practice
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Possibly a topic for a separate discussion, but documentation should include
- Purpose of repo
- Overall structure (of repo)
- How to use (main use case, additional usecases)
- Invoking workflow (if applicable)
- functions of interest
- How to contribute (development usecase)
Originally posted by @AlexAxthelm in https://github.com/RMI-PACTA/practices/pull/12#discussion_r1482942723
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 proposed documentation.md practice and the checklist in this issue. Define the practice so it covers the repository purpose and structure, usage and workflows, functions of interest, and contribution guidance; done means all listed areas are addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100