ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 ouverte le 3 oct. 2016

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (86 forks)batch import
documentationeasyhacktoberfesthelp wanted

Métriques du dépôt

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

Description

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.

Guide contributeur

Direction de recherche
Examinez la structure actuelle du référentiel, identifiez les domaines clés tels que l'organisation du code, les tests et la documentation de l'API, puis rédigez des directives de contribution en suivant les meilleures pratiques de projets open source similaires.
Stack technique
python
Domaine
computer visiondocumentation
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.
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
GitGitHub
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90