coala / coala/cEPs

Make a cEP about API doc guidelines

Open
#47 0 comments 0 reactions 0 assignees View on GitHub
New cEP status/STALE
Dominant language
No language data
Stars
34
Forks
50
PR merge metrics
No merged PRs in 30d

Description

Maybe we can even have a bear and enforce a bit of API docs incrementally?

Opened via [gitter](https://gitter.im/coala/coala/?at=584c6c1dbe9d43bc63442483) by @sils

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the issue body and its linked Gitter discussion. Clarify whether the intended work is an API documentation guideline cEP and what “enforce ... incrementally” means; done would require a defined, accepted proposal, but no files or tests are identified.

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
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.