Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Creating contribution guidelines & inline doc templates #100

Open
arimgibson opened this issue Apr 24, 2022 · 1 comment
Open

[docs] Creating contribution guidelines & inline doc templates #100

arimgibson opened this issue Apr 24, 2022 · 1 comment
Assignees
@dawsbot
Labels
Epic Big or tricky

Comments

@arimgibson
Copy link
Contributor

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.
@arimgibson arimgibson added the Epic Big or tricky label Apr 24, 2022
@dawsbot dawsbot self-assigned this Apr 24, 2022
@dawsbot
Copy link
Owner

dawsbot commented Apr 24, 2022 •
edited
Loading

Awesome idea @arimgibson! I'll take care of this soon ✅

@dawsbot dawsbot changed the title Creating contribution guidelines & inline doc templates [docs] Creating contribution guidelines & inline doc templates Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dawsbot dawsbot

Labels
Epic Big or tricky
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dawsbot @arimgibson