dwyl / dwyl/contributing

How/where/what to document

Open
#69 4 comments 2 reactions 0 assignees View on GitHub
discuss enhancement help wanted
Dominant language
No language data
Stars
91
Forks
9
PR merge metrics
No merged PRs in 30d

Description

I have always felt that there should be more of a process/guidelines when it comes to documenting stuff. I imagine there is a lot overlap with what you want to be documented across projects (permissions/routes/user-flows/getting-started/...).

It would help to have a specific guide to follow so that I know where to add this piece of information rather than just stick it on the end of a potentially long readme.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.