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

Repository doesn't have a quick start section in the README #17

Open
maxdeviant opened this issue Oct 6, 2020 · 0 comments
Open

Repository doesn't have a quick start section in the README #17

maxdeviant opened this issue Oct 6, 2020 · 0 comments
Labels
good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation.

Comments

@maxdeviant
Copy link
Member

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have in their README a short summary of the library's purpose, installation instructions, a quick start with a minimal usage example, and links to the documentation and contributing guide.

This library currently doesn't have a quick start in the README.

Describe the solution you'd like
The library needs a quick start section after the installation instructions. argonaut-codecs is one example of a library with a quick start.

Additional context
See the Governance repository for more information about requirements in the Contributors organization.
@thomashoneyman thomashoneyman added type: documentation Improvements or additions to documentation. good first issue First-time contributors who are looking to help should work on these issues. help wanted labels Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation.
Milestone
No milestone
Development

No branches or pull requests
3 participants
@maxdeviant @JordanMartinez @thomashoneyman