IEEE-VIT/pykitzoid

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

Ouverte

#58 ouverte le 17 sept. 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Go (20 forks)auto 404
difficulty: easydocumentationgood first issue

Métriques du dépôt

Stars
 (11 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Créez un nouveau fichier CONTRIBUTING.md et mettez à jour le lien dans README.md. Assurez vous que le guide inclut la configuration, les conventions de nommage des branches, les directives de messages de commit et le processus de pull request.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90