ronantakizawa/garbagetruck

Add CONTRIBUTING.md guidelines

Open

#1 opened on Jul 25, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (3 forks)auto 404
bugcommunitydocumentationenhancementhelp wantedpriority: mediumtesting

Repository metrics

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

Description

Description

A CONTRIBUTING.md file helps new contributors understand how to contribute to the project effectively.

Tasks

  • Create CONTRIBUTING.md file
  • Define code style guidelines
  • Explain the pull request process
  • Add issue reporting guidelines
  • Include development setup instructions
  • Add code of conduct reference

Labels

  • documentation
  • community
  • help wanted

Contributor guide

Research direction
Create a CONTRIBUTING.md file following standard open source project structure. Include sections for code style, pull request process, issue reporting, development setup, and code of conduct reference. Use the issue tasks as a checklist.
Tech stack
None
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85