swap0506/acroecology-project_

Enhancement of CONTRIBUTING.md

Open

#44 opened on Sep 3, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)TypeScript (20 forks)auto 404
documentationgood first issuegssoc'25level 1

Repository metrics

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

Description

✨ Description

While CropVision has a strong mission and technical foundation, the project is currently missing a detailed CONTRIBUTING.md file (or has a basic one). Adding or enhancing it with clear contribution guidelines will help onboard new developers more easily and promote open-source collaboration.

✅ Benefits of Enhancing CONTRIBUTING.md:

  • Clarifies how to contribute (fork, branch, PR, commit style)

  • Defines development and testing setup

  • Encourages community participation and consistency

  • Improves issue reporting and feature suggestions

  • Strengthens the professional presentation of the project

📌 Suggested Additions

  • Code of Conduct

  • Branch naming conventions

  • Commit message guidelines (e.g., Conventional Commits)

  • Bug report and feature request guidelines

Please assign this issue to me. I would like to contribute on this issue.

Contributor guide

Research direction
Check if a CONTRIBUTING.md file already exists in the repository. If it does, review its contents and identify missing sections as described in the issue. If not, create a new CONTRIBUTING.md with the suggested additions: code of conduct, branch naming conventions, commit message guidelines, and bug/feature request templates.
Tech stack
typescript
Domain
backend
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90