Best practice to document configuration files
Open
Nobody has claimed this yet.
best-practice
config
documentation
yml
- Dominant language
- No language data
- Stars
- 17
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Here is the opinion of some rOpenSci folks
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 by reviewing the rOpenSci opinion shown in the issue image and determine what configuration-file documentation this repository is expected to provide. The issue does not name files, tests, or a concrete documentation change, so the scope and definition of done need clarification before work can begin.
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
- 20/100