lenra-io/client-lib-js

[Task] Improve contribution documentation

Open

#12 opened on Jan 19, 2024

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

Repository metrics

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

Description

What should be done

Add some documentation in the Contributing part to make it easy to start working on it.

Contributor guide

Research direction
Review existing contributing guide, identify gaps, and look at other projects' contribution docs for inspiration.
Tech stack
typescript
Domain
frontend
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85