ajaynegi33/LibraryMan

Update Readme

Open

#2 opened on Oct 4, 2023

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)JavaScript (25 forks)auto 404
documentationenhancementgood first issuehacktoberfest

Repository metrics

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

Description

Here are the details for updating the README:

  1. Project Overview: In the README, please provide an overview of the project, explaining what it does and its main features. This will help visitors quickly understand the purpose of the project.

  2. Contributing Guidelines: Update the CONTRIBUTING.md file as well. Specifically, please provide clear and detailed instructions on how to set up the project and get it running locally. Ensure that the setup process is well-documented and beginner-friendly.

Feel free to reach out if you have any questions or need further information. Your contributions to improving our project documentation are greatly appreciated!

Contributor guide

Research direction
Read the current README.md and CONTRIBUTING.md, then edit them according to the issue description. Use markdown syntax. Test locally by previewing the markdown files before committing.
Tech stack
javascript
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.
Under 1 hour
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.
90