ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 geöffnet am 3. Okt. 2016

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (86 Forks)batch import
documentationeasyhacktoberfesthelp wanted

Repository-Metriken

Stars
 (526 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

This will make things easier for the contributors.

Some important points to be highlighted in the contributing guide would be:

  • How to contribute - improve documentation/add new methods/improve performance.
  • Explain contribution workflow - issues/pull-request/review.
  • An overview of code structure and API.
  • Coding practices to follow.
  • Guide to add a new image processing method.

Any suggestions are welcome. Thanks.

Contributor Guide

Research-Richtung
Überprüfe die aktuelle Repository Struktur, identifiziere Schlüsselbereiche wie Codebasis Organisation, Tests und API Dokumentation, und erstelle dann Richtlinien für Mitwirkende, die den Best Practices ähnlicher Open Source Projekte folgen.
Tech Stack
python
Domain
computer visiondocumentation
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitGitHub
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90