Vasu10134/Book-Finder

Adding Contribution Guidelines

Open

#4 opened on Oct 24, 2025

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (0 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

Add CONTRIBUTING Guidelines

This repository does not currently have a CONTRIBUTING.md file.
To help new contributors understand how to get started and contribute effectively, we should add one.

Tasks

  • Create a new file named CONTRIBUTING.md in the root directory.
  • Include information such as:
    • How to fork and clone the repository
    • Branch naming conventions
    • How to submit pull requests
    • Coding style or formatting rules (if any)
    • Issue and PR guidelines

Why This is Important

  • Helps new contributors understand the contribution workflow.
  • Ensures consistency in how contributions are made.
  • Reduces confusion and repetitive questions.
  • Makes the project more contributor-friendly, especially during Hacktoberfest.

Contributor guide

Research direction
Research common contributing guidelines for open source projects, then create a CONTRIBUTING.md file in the root directory.
Tech stack
typescriptreacttailwindcss
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