dawsbot / dawsbot/essential-eth

[docs] Creating contribution guidelines & inline doc templates

Open
#100 1 comment 1 reaction 1 assignee Claimed by @dawsbot View on GitHub
Epic
Dominant language
TypeScript
Stars
310
Forks
34
PR merge metrics
No merged PRs in 30d

Description

As people start to contribute to the repository, it'd be good to have contribution guidelines setup for consistency. The documentation throughout the repository changes subtly as well; having a set template and key information about how to document would be helpful as `essential-eth` migrates away form `README` documentation into exclusively `TypeDoc` documentation compiled through Docusaurus.

I'm feeling a calling to take this one on @dawsbot but you've obviously been maintaining the repo longest; let me know if you'd rather be assigned to this issue.

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.