helpshift/mongrove

Improve README

Open

#14 opened on Jan 21, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Clojure (8 forks)auto 404
documentationgood first issue

Repository metrics

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

Description

Improve README doc. Things that can be added:

  1. Description and purpose
  2. Getting started guide
  3. Contributing guide
  4. API doc link

Contributor guide

Research direction
Read the current README, then add sections for Description, Getting Started, Contributing, and API doc link.
Tech stack
clojure
Domain
backenddatabase
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90