Déplace la documentation de "contributing.md" vers ReadTheDocs #3890

pierre-24 · 2016-10-22T20:02:22Z

Q	R
Type de modification	Évolution
Ticket(s) (issue(s)) concerné(s)	#3865

QA Remarques

Je vais me faire incendier pour les commandes git, mais je tente. C'est bien entendu basé sur ce sujet du regretté (par moi, en tout cas) @Alex-D ;)
N'hésitez par à me signaler quoique ce soit qui n'est pas clair. C'est, à priori, la première page sur laquelle un nouveau contributeur va tomber (en tout cas je l'ai réécrite sous cet angle là), donc il faut qu'elle soit explicite.
Moi et la grammaire, ça fait 42. Relisez moi aussi pour ça, d'avance merci :)

coveralls · 2016-10-22T20:10:49Z

Coverage remained the same at 87.609% when pulling c8406a9 on pierre-24:fix_3865_doc into ddcc2c8 on zestedesavoir:dev.

Alex-D · 2016-10-22T21:15:49Z

Ne parles pas de moi comme si j'étais mort, je suis juste sur d'autres projets :)

coveralls · 2016-10-23T08:56:01Z

Coverage remained the same at 87.609% when pulling 64cf4bd on pierre-24:fix_3865_doc into ddcc2c8 on zestedesavoir:dev.

Alex-D · 2016-10-23T12:22:16Z

git fetch --all --prune est assez sympa dans le genre :)
Mais je vois bien dans le document présenté ici un git fetch upstream qui va donc prendre toutes les branches de l'upstream et les mettre sur ton poste. Attention à ne pas confondre pull et fetch qui ne font pas la même chose. Pull sert à "tirer" les mises à jour distantes d'une branche et à les mettre dans ta branche actuelle, celle sur laquelle tu travailles. Pratique quand tu travail depuis plusieurs machines et que tu veux récupérer quelque chose de ton origin que tu a push depuis ailleurs, ou si il y a plusieurs personnes à travailler sur l'origin ou encore si il y a eu des pull requests merged.
Fetch lui sert à aller prendre les branches en ligne sur n'importe quel remote et aller les stocker localement pour les rendre disponibles quand tu en aura besoin. Par exemple une fois que tu auras fetch l'upstream, tu seras en mesure de faire un git checkout upstream/prod ou encore, pour un hotfix git checkout -b hotfix-monhotfix upstream/prod pour te créer une nouvelle branche locale (que tu vas push sur ton origin) qui sera à jour (si tu as fetch juste avant) par rapport à l'upstream aka le dépôt zds-site ici.

Voilà c'était mon pavé, tout le plaisir est pour moi.

AmauryCarrade · 2016-10-23T12:45:58Z

doc/source/contributing.rst

+Contribuer à Zeste de Savoir
+============================
+
+Cette page explique, brievement, la procédures pour contribuer à Zeste de Savoir.


brièvement ; la procédure (sans s)

AmauryCarrade · 2016-10-23T12:47:42Z

doc/source/contributing.rst

+
+Pour contribuer, il est nécessaire de posséder `un compte GitHub <https://github.com/signup/free>`__.
+
+Deux dépôts (*remotes*) sont en fait nécessaire :


nécessaires

AmauryCarrade · 2016-10-23T12:50:06Z

doc/source/contributing.rst

+
+    git clone https://github.com/<login>/zds-site
+
+Une copie de votre dépôt est alors téléchargée. On rajoute ensuite le *remote* ``upstream`` grâce à:


Il manque une espace avant : (bon d'accord, là c'est de l'ordre du détail). Il y a d'autres erreurs de typographie du genre dans le reste, je n'en signale qu'une vue l'importance relative.

AmauryCarrade · 2016-10-23T12:52:24Z

doc/source/contributing.rst

+
+    git checkout -b VOTRE_BRANCHE_LOCALE upstream/dev
+
+Cette commande créer la branche ``VOTRE_BRANCHE_LOCALE``, qui est basée sur dernière version de Zeste de Savoir (la branche ``dev``).


Cette commande crée la branche

AmauryCarrade · 2016-10-23T12:53:30Z

doc/source/contributing.rst

+C'est les modifications issues de cette branche qui seront ensuite proposées, donc vous pouvez créer autant de branches que nécéssaire.
+Pensez à préfixer vos branches selon l'objet de votre PR : ``hotfix-XXX``, ``feature-XXX``, etc (ou XXX peut, par exemple, être le numéro de l'*issue*).
+
+Chacune de vos modification doit s'accompagner d'un *commit*. Une des manières de faire est d'utiliser la commande ci-dessous:


de vos modifications

AmauryCarrade · 2016-10-23T12:54:08Z

doc/source/contributing.rst

+
+    git commit -av
+
+Cette commande ouvre un éditeur de texte, dans lequel vous indiquer le message de *commit*, c'est à dire un résumé de vos modifications. Faites des messages de *commit* **clairs** et si possible en français (voir les "bonnes pratiques" ci-dessous).


dans lequel vous indiquez

AmauryCarrade · 2016-10-23T12:57:22Z

doc/source/contributing.rst

+ Le code et les commentaires doivent être rédigés en anglais.
+ N'hésitez pas à rajouter des `docstrings (PEP 257) <https://www.python.org/dev/peps/pep-0257/>`_.
+ Assurez-vous que le code suit la `PEP-8 <http://legacy.python.org/dev/peps/pep-0008/>`_ (conventions de formatage de python) grâce à ``tox -e flake8``. Veillez également à respecter `les conventions de code de Django <https://docs.djangoproject.com/en/1.7/internals/contributing/writing-code/coding-style/>`_.
+ Des *tests* assurent que les modifications que vous apportez n'induisent pas d'effet secondaires. Assurez-vous donc que l'intégralité des tests passent : ``python manage.py test``. Si nécéssaire, ajoutez un test pour votre modification. Seules les modifications de documentation et les réusinages n'ont pas besoin de nouveaux tests. **Votre test doit échouer sans votre modification, et réussir avec**. Il n'y a aucune chance que votre *pull request* soit acceptée sans son test associé.


si nécessaire, ajoutez...

AmauryCarrade · 2016-10-23T12:58:36Z

doc/source/contributing.rst

+Tous les détails sur le *workflow* se trouvent `sur la page dédiée <http://zds-site.readthedocs.org/fr/latest/workflow.html>`__. En résumé,
+
+ Les PR sont unitaires. Aucune PR qui corrige plusieurs problèmes ou apporte plusieurs fonctionnalité ne sera accepté (sauf ZEP).
+ Ces PR sont mergées dans la branche ``dev`` (ou dans la branche de *release* s'il s'agit de correction de bug suite à la bêta) après une QA légère.


On pourrait dire fusionnées, éventuellement.

coveralls · 2016-10-23T19:03:40Z

Coverage remained the same at 87.609% when pulling 561d1eb on pierre-24:fix_3865_doc into ddcc2c8 on zestedesavoir:dev.

coveralls · 2016-10-23T19:05:09Z

Coverage remained the same at 87.609% when pulling 561d1eb on pierre-24:fix_3865_doc into ddcc2c8 on zestedesavoir:dev.

coveralls · 2016-10-23T19:09:50Z

Coverage remained the same at 87.609% when pulling 561d1eb on pierre-24:fix_3865_doc into ddcc2c8 on zestedesavoir:dev.

Alex-D · 2016-10-23T19:41:25Z

Pourquoi il est passé 3 fois sur le même sha1 ce bordel là ?

pierre-24 · 2016-10-23T19:43:58Z

Parce que j'ai fait 3 --force. C'est mal :p

Alex-D · 2016-10-23T20:14:58Z

Normalement le sha1 aurait dû être différent à chaque fois, du coup ça m'étonne, mais OK.

SpaceFox · 2016-10-23T20:26:18Z

Je vais me faire incendier pour les commandes git, mais je tente.

Je trouve ça toujours aussi nul, mais tant que j'aurai pas fini mon tuto Git, je ne peux pas trop l'ouvrir. Cela dit, s'il y a au moins les explications en français de ce que font les commandes, tu peux les laisser.

Taluu · 2016-10-24T21:02:57Z

Hum, je ne sais pas si déplacer tout le CONTRIBUTING dans les docs est une bonne chose (standards, toussa toussa). Mais, pour mettre de l'eau dans mon vin, comme un lien est fait, a la rigueur... ¯\_(ツ)_/¯

Et... euhm,,, avoir une sorte de tuto pour contribuer sur github n'a IMO pas sa place dans une doc... Après, certes, y'en a pas sur ZdS, mais c'est pas une raison pour porter ça ici... Surtout que l'aide de github est mine de rien drôlement bien foutue. OK c'est en anglais, mais c'est pas sorcier...

pierre-24 · 2016-10-25T09:45:33Z

J'le savais ^^

Pour le contributing, c'est un choix qui se défend, parce qu'au moins, tout est enfin ensemble. En plus, on oublie qu'il existe, par exemple dans le contriuting, là, la template pour les PRs est incorrecte.

Pour git, j'ai pas d'excuse, si ce n'est "aider le petit débutant". Sauf que ça fait pas sérieux. Comme vous voulez, en fait.

DevHugo · 2017-01-31T13:04:47Z

On en est ou ici ?

pierre-24 · 2017-01-31T13:12:26Z

C'pas un franc succès :p

pierre-24 · 2017-08-02T12:01:28Z

Bon, échec :p

Déplace la documentation de "contributing.md" vers ReadTheDocs

c8406a9

Mise à jour du README

64cf4bd

AmauryCarrade reviewed Oct 23, 2016

View reviewed changes

pierre-24 force-pushed the fix_3865_doc branch from 0dcd7c9 to bc73f37 Compare October 23, 2016 18:57

Orthographe + améliorations

561d1eb

pierre-24 force-pushed the fix_3865_doc branch from bc73f37 to 561d1eb Compare October 23, 2016 18:59

vhf force-pushed the dev branch from 568a74a to 77df530 Compare November 19, 2016 20:16

pierre-24 mentioned this pull request Nov 21, 2016

[Discussion][WIP] Code style #3998

Closed

pierre-24 closed this Aug 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Déplace la documentation de "contributing.md" vers ReadTheDocs #3890

Déplace la documentation de "contributing.md" vers ReadTheDocs #3890

pierre-24 commented Oct 22, 2016 •

edited

Loading

coveralls commented Oct 22, 2016 •

edited

Loading

Alex-D commented Oct 22, 2016

coveralls commented Oct 23, 2016 •

edited

Loading

Alex-D commented Oct 23, 2016 •

edited

Loading

AmauryCarrade Oct 23, 2016

AmauryCarrade Oct 23, 2016

AmauryCarrade Oct 23, 2016 •

edited

Loading

AmauryCarrade Oct 23, 2016 •

edited

Loading

AmauryCarrade Oct 23, 2016

AmauryCarrade Oct 23, 2016

AmauryCarrade Oct 23, 2016

AmauryCarrade Oct 23, 2016

coveralls commented Oct 23, 2016 •

edited

Loading

coveralls commented Oct 23, 2016 •

edited

Loading

coveralls commented Oct 23, 2016 •

edited

Loading

Alex-D commented Oct 23, 2016

pierre-24 commented Oct 23, 2016

Alex-D commented Oct 23, 2016

SpaceFox commented Oct 23, 2016

Taluu commented Oct 24, 2016 •

edited

Loading

pierre-24 commented Oct 25, 2016 •

edited

Loading

DevHugo commented Jan 31, 2017

pierre-24 commented Jan 31, 2017

pierre-24 commented Aug 2, 2017


		Pour contribuer, il est nécessaire de posséder `un compte GitHub <https://github.com/signup/free>`__.

		Deux dépôts (remotes) sont en fait nécessaire :


		git clone https://github.com/<login>/zds-site

		Une copie de votre dépôt est alors téléchargée. On rajoute ensuite le remote ``upstream`` grâce à:


		git checkout -b VOTRE_BRANCHE_LOCALE upstream/dev

		Cette commande créer la branche ``VOTRE_BRANCHE_LOCALE``, qui est basée sur dernière version de Zeste de Savoir (la branche ``dev``).


		git commit -av

		Cette commande ouvre un éditeur de texte, dans lequel vous indiquer le message de commit, c'est à dire un résumé de vos modifications. Faites des messages de commit clairs et si possible en français (voir les "bonnes pratiques" ci-dessous).

Déplace la documentation de "contributing.md" vers ReadTheDocs #3890

Déplace la documentation de "contributing.md" vers ReadTheDocs #3890

Conversation

pierre-24 commented Oct 22, 2016 • edited Loading

QA Remarques

coveralls commented Oct 22, 2016 • edited Loading

Alex-D commented Oct 22, 2016

coveralls commented Oct 23, 2016 • edited Loading

Alex-D commented Oct 23, 2016 • edited Loading

AmauryCarrade Oct 23, 2016

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016 • edited Loading

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016 • edited Loading

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016

Choose a reason for hiding this comment

AmauryCarrade Oct 23, 2016

Choose a reason for hiding this comment

coveralls commented Oct 23, 2016 • edited Loading

coveralls commented Oct 23, 2016 • edited Loading

coveralls commented Oct 23, 2016 • edited Loading

Alex-D commented Oct 23, 2016

pierre-24 commented Oct 23, 2016

Alex-D commented Oct 23, 2016

SpaceFox commented Oct 23, 2016

Taluu commented Oct 24, 2016 • edited Loading

pierre-24 commented Oct 25, 2016 • edited Loading

DevHugo commented Jan 31, 2017

pierre-24 commented Jan 31, 2017

pierre-24 commented Aug 2, 2017

pierre-24 commented Oct 22, 2016 •

edited

Loading

coveralls commented Oct 22, 2016 •

edited

Loading

coveralls commented Oct 23, 2016 •

edited

Loading

Alex-D commented Oct 23, 2016 •

edited

Loading

AmauryCarrade Oct 23, 2016 •

edited

Loading

AmauryCarrade Oct 23, 2016 •

edited

Loading

coveralls commented Oct 23, 2016 •

edited

Loading

coveralls commented Oct 23, 2016 •

edited

Loading

coveralls commented Oct 23, 2016 •

edited

Loading

Taluu commented Oct 24, 2016 •

edited

Loading

pierre-24 commented Oct 25, 2016 •

edited

Loading