shadiqaddoura/habit-tracker

Create CONTRIBUTING.md Guide

Open

#14 opened on Apr 23, 2025

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

Repository metrics

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

Description

Description

Create a comprehensive CONTRIBUTING.md guide to help new contributors understand how to contribute to the project effectively.

Requirements

  • Explain the project structure and architecture
  • Provide setup instructions for development
  • Document coding standards and conventions
  • Explain the pull request process
  • Include information about issue labels and priorities
  • Add guidelines for creating good issues and pull requests

Technical Considerations

  • Keep the guide up-to-date with project changes
  • Make it accessible to developers of all experience levels
  • Include examples where helpful

Acceptance Criteria

  • New contributors can easily understand how to contribute
  • The guide covers all aspects of the contribution process
  • The document is well-organized and easy to navigate
  • Examples are provided for common contribution scenarios

Contributor guide

Research direction
Review the project structure and document contribution steps.
Tech stack
javascript
Domain
developer experience
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.
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.
90