IEEE-VIT/pykitzoid

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

Offen

#58 geöffnet am 17.09.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (20 Forks)auto 404
difficulty: easydocumentationgood first issue

Repository-Metriken

Stars
 (11 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Erstellen Sie eine neue CONTRIBUTING.md Datei und aktualisieren Sie den Link in der README.md. Stellen Sie sicher, dass der Leitfaden die Einrichtung, Branch Namenskonventionen, Commit Nachrichten Richtlinien und den Pull Request Prozess enthält.
Tech Stack
go
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90