OpenGenus/cosmos

Explanation file of implemented code

Open

#4 957 ouverte le 30 mars 2020

Voir sur GitHub
 (8 commentaires) (0 réactions) (1 assigné)C++ (3 724 forks)batch import
enhancementgood first issue

Métriques du dépôt

Stars
 (13 462 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Choisissez un algorithme du dépôt, étudiez son code et créez un fichier README.md expliquant l'algorithme avec du texte et des diagrammes. Incluez des exemples et une analyse de complexité.
Stack technique
Aucun
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
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.
80