daabChingrii/website

Create a Contributing Guide

Open

#4 opened on Oct 31, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (4 forks)auto 404
Hacktoberfestdocumentationgood first issuehacktoberfest-accepted

Repository metrics

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

Description

Description: Add a CONTRIBUTING.md file to guide contributors. Include information about branching, committing, and submitting PRs. Expected Outcome: A well-structured contributing guide that outlines best practices for contributing to the repository.

Contributor guide

Research direction
Research existing contributing guides from popular open source projects to understand common sections and best practices. Structure the guide to include sections on how to fork, branch, commit, and submit pull requests, as well as code style and testing guidelines.
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.
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.
Fresh
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.
85