portkey-cloud/portkey

Write a good README

Open

#30 opened on Sep 6, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Clojure (7 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (146 stars)
PR merge metrics
 (PR metrics pending)

Description

Write a README assuming no AWS knowledge that guide the user step by step.

Contributor guide

Research direction
Examine existing READMEs of similar projects for structure, then write a step by step guide covering installation, configuration, basic usage, and examples for Portkey, assuming no prior AWS knowledge.
Tech stack
clojure
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85