IEEE-VIT/pykitzoid

Fix the broken link to CONTRIBUTING.md in the README.md and create a new contributing guide

Open

#58 opened on Sep 17, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (20 forks)auto 404
difficulty: easydocumentationgood first issue

Repository metrics

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

Description

The current README.md contains a link to CONTRIBUTING.md which is broken or outdated. This makes it difficult for new contributors to find guidelines.

Here are some things to include in it :

Create a new CONTRIBUTING.md guide with clear contribution steps, including: How to set up the project locally Branch naming conventions Commit message guidelines Pull request process

Contributor guide

Research direction
Create a new CONTRIBUTING.md file and update the link in README.md. Ensure the guide includes setup, branch naming, commit messages, and PR process.
Tech stack
go
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.
90