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

Make it easy for users to contribute #104

Open

crhistianramirez opened this issue Aug 12, 2019 · 0 comments

Labels

Contributor

crhistianramirez commented Aug 12, 2019

Documentation for our documentation. Let's add some relevant READMEs to make it easy for people to contribute, both internal and external.

CONTRIBUTING.MD - guidelines for how to write each type of doc, resources for good technical writing, examples for how to use syntax highlighting for code blocks, what kind of frontmatter each doc needs
README.md with requirements, how to run locally, link to CONTRIBUTING.md, link to LICENCE.md
Possibly doc templates for the different types of issues someone can create: docs, bugs. Example:

Anything else you can think of that might be helpful for someone to easily contribute.

The text was updated successfully, but these errors were encountered:

crhistianramirez added the documentation label

crhistianramirez added this to the beta-release milestone

crhistianramirez modified the milestones: beta-release, phase-two

robertsoniv removed this from the MVP Fast Follows milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment