OpenGenus/cosmos

Explanation file of implemented code

Open

#4.957 geöffnet am 30. März 2020

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (3.724 Forks)batch import
enhancementgood first issue

Repository-Metriken

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

Beschreibung

This is a(n):

  • New algorithm
  • Update to an existing algorithm
  • Error
  • Proposal to the Repository

Details:

We can make a file may be READ.md file in every algorithm. reading code without explanation is difficult for learners so I am proposing an explanation of implemented programs using gifs, text, or any pictorial method. Reading merely code doesn't help much but explanation does help. I would like to work on it.

Contributor Guide

Research-Richtung
Wähle einen Algorithmus aus dem Repository aus, studiere seinen Code und erstelle eine README.md Datei, die den Algorithmus mit Text und Diagrammen erklärt. Füge Beispiele und Komplexitätsanalyse hinzu.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80