soumyo-jeet/assist-ai

Make `CONTRIBUTING.md` More Beginner-Friendly and Professional

Open

#27 opened on Oct 22, 2025

View on GitHubContributor guide
 (3 comments) (0 reactions) (1 assignee)JavaScript (8 forks)auto 404
documentationeasyhacktoberfestopen-odyssey-2.0

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Issue: Make CONTRIBUTING.md More Beginner-Friendly and Professional

Description
I want to update and refine the CONTRIBUTING.md file to make it clearer, beginner-friendly, and more professional.
The goal is to help new contributors understand the workflow easily while keeping the tone welcoming and consistent.

Proposed Improvements

  • Simplify the language for first-time contributors
  • Organize sections with clear headings and easy-to-follow steps
  • Use markdown tables or bullet points for readability
  • Add emojis for a friendly tone and better visual flow
  • Format commands with proper code blocks
  • Include short tips for writing good commit messages and PR descriptions
  • Maintain a professional, inclusive, and consistent tone

Why This Change Enhancing the CONTRIBUTING.md will make it easier for beginners to start contributing, keep PRs consistent, and reflect a polished, professional open-source environment.

Contributor guide

Research direction
Review the current CONTRIBUTING.md, then restructure with clear headings, step by step instructions, and emojis for a friendly tone. Ensure commands are in code blocks and include tips for commit messages and PR descriptions.
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.
Half day
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
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85