carlosazaustre/devask

add documents for contributing and better readme

Open

#10 opened on Oct 4, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)TypeScript (5 forks)auto 404
documentationgood first issuehacktoberfest

Repository metrics

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

Description

This issue does not include a description.

Contributor guide

Research direction
Review the existing project structure and README to identify missing sections, then draft a contributing guide and improved README.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
75