|
| 1 | +# Contribuer |
| 2 | + |
| 3 | +Nous aimons les contributions (sous la forme de pull requests). En contribuant à ce repertoire, vous acceptez de suivre les |
| 4 | +règles du [Code de conduite](CODE_OF_CONDUCT_FR.md). |
| 5 | + |
| 6 | +## Mise en route |
| 7 | + |
| 8 | +* Dans un premier temps [forkez][fork] le repertoire puis clonez le grâce à la commande: |
| 9 | + |
| 10 | + git clone git@github.com:votre-pseudo-github/algorithms.git |
| 11 | + |
| 12 | +* Ensuite, créez une nouvelle branche dans laquelle vous effectuerez vos changements. For example: |
| 13 | + * add_XXX si vous allez ajouter de nouveaux algorithmes ou de nouvelles structures de données. |
| 14 | + * fix_XXX si vous allez corriger un bogue sur un certain algorithme ou structure de données. |
| 15 | + * test_XXX si vous avez écrit un ou des tests. |
| 16 | + * doc_XXX si vous avez ajouté ou édité de la documentation. |
| 17 | + |
| 18 | +Vous pouvez contribuer en : |
| 19 | +- implémenter un nouvel algorithme dans ce repertoire. Faites bien attention à |
| 20 | +le mettre dans la bonne section (i.e. [array](array), [dp](dp), etc). Vous pouvez créer une nouvelle |
| 21 | +section si besoin. Assurez-vous que votre implémentation fonctionne, |
| 22 | +- optimisant et en améliorant les algorithmes déjà présents, |
| 23 | +- ajoutant de nouvelles solutions aux problèmes, |
| 24 | +- trouvant et corrigeant des bogues, |
| 25 | +- ajoutant des exemples afin de mieux expliquer le fonctionnement des algorithmes, |
| 26 | +- ajoutant des tests, |
| 27 | +- améliorant la documentation. |
| 28 | + |
| 29 | +## Pull Requests |
| 30 | +Poussez votre fork sur git et [soumettez une nouvelle pull request][pr]. |
| 31 | +Nous examinerons et pourrons suggérer des changements, des améliorations ou des solutions de rechange. |
| 32 | +Pour faciliter l'acceptation, vous pouvez vérifier que : |
| 33 | + |
| 34 | +* tous les algorithmes doivent être écrits en **Python 3**, |
| 35 | +(il reste encore quelques algorithmes écrits en _Python 2_. Vous pouvez commencer par convertir ces |
| 36 | +[derniers][issue120] vers du _Python 3_), |
| 37 | +* écrire un code propre et compréhensible, |
| 38 | +* commenter correctement le code et expliquer brièvement ce que l'algorithme fait dans la [documentation][docstr], |
| 39 | +* vous pouvez également expliquer le résultat à l'aide d'un exemple simple. |
| 40 | +* essayer d'écrire quelques tests pour les algorithmes, |
| 41 | +* écrire un [message de soumission (commit) clair][commit]. |
| 42 | + |
| 43 | + |
| 44 | +## Problèmes |
| 45 | +Soumettez une [nouveau issue][newissue] s'il y a un algorithme à ajouter, ou si un bogue a été trouvé dans un algorithme existant. Avant d'en soumettre une nouvelle, veuillez passer en revue les [issues existantes][issues] afin d'éviter de créer des doublons. Envisagez également de résoudre des issues actuellement ouvertes ou de contribuer à la discussion sur une issue. |
| 46 | + |
| 47 | +## Collaborateurs |
| 48 | +Vous pouvez demander de l'aide ou des éclaircissements aux collaborateurs. |
| 49 | +[Keon Kim](https://github.com/keon) |
| 50 | + |
| 51 | +[Rahul Goswami](https://github.com/goswami-rahul) |
| 52 | + |
| 53 | +[Ankit Agarwal](https://github.com/ankit167) |
| 54 | + |
| 55 | +[Hai Hoang Dang](https://github.com/danghai) |
| 56 | + |
| 57 | +[Saad](https://github.com/SaadBenn) |
| 58 | + |
| 59 | +[fork]: https://help.github.com/articles/fork-a-repo/ |
| 60 | +[docstr]: https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings |
| 61 | +[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
| 62 | +[pr]: https://github.com/keon/algorithms/compare/ |
| 63 | +[newissue]: https://github.com/keon/algorithms/issues/new |
| 64 | +[issue120]: https://github.com/keon/algorithms/issues/120 |
| 65 | +[issues]: https://github.com/keon/algorithms/issues/ |
0 commit comments