Améliorez vos compétences avec la communauté Real Python Slack – Real Python

By | octobre 21, 2020

Cours Python en ligne

le Vrai Python Community Slack est une communauté Python anglophone avec des membres répartis dans le monde entier. C'est un groupe accueillant dans lequel vous êtes libre de discuter de vos questions de codage et de carrière, de célébrer vos progrès, de voter sur les prochains sujets de didacticiel ou simplement de passer du temps avec nous à la fontaine virtuelle.

En tant que membre de la communauté, vous avez également accès à nos heures de bureau hebdomadaires, une session de questions-réponses en ligne en direct avec le Vrai Python l'équipe où vous rencontrerez d'autres pythonistes pour discuter de vos progrès d'apprentissage, poser des questions et discuter des trucs et astuces Python via le partage d'écran.

Le but de ce guide est de vous aider:

  • Naviguez dans certains Fonctionnalités les plus utiles de Slack
  • Tirez le meilleur parti de Vrai Python Communauté Slack
  • Obtenir votre questions répondues par d'autre Vrai Python membres
  • Apprendre à communiquer les problèmes techniques à vos pairs
  • Familiarisez-vous avec les outils que vous utiliserez lorsque vous recevrez votre premier (ou votre prochain) emploi de développeur

Nous mettrons à jour ce guide périodiquement et serons heureux de recevoir toutes les recommandations ou questions que vous pourriez avoir. Vous pouvez les partager avec moi (@Ricky White) dans Slack ou dans les commentaires ci-dessous. Nous ferons toutes les annonces de mise à jour dans le #hangouts canal de Slack.

Publication réussie sur Slack

Slack vous permet de publier des messages et de poser des questions que tout le monde au sein de la chaîne peut voir. Vous pouvez également envoyer des messages directs à des utilisateurs individuels. Cependant, il y a quelques points à considérer avant d'appuyer sur ce bouton d'envoi. Examinons ces considérations dans le contexte des trois façons les plus courantes de publier des messages dans Slack: répondre, publier et publier des messages croisés.

Répondre à la question d'un membre

La meilleure façon de répondre à la publication d'un autre membre est d'utiliser le Répondre dans le fil bouton. En utilisant fils présente l'avantage de conserver toute la conversation au même endroit, ce qui ne se produira pas si vous répondez avec un nouveau message.

Voici un exemple d'utilisation Répondre dans le fil:

La fonctionnalité de fil de discussion est un excellent moyen de garantir que les questions des autres membres ne soient pas enterrées dans une vague de réponses à une question précédente, ce qui peut entraîner des questions sans réponse.

Un autre avantage des threads est qu'ils indiquent très clairement aux assistants communautaires quelles questions ont déjà reçu une réponse et celles qui restent sans réponse. Cela aide les membres à déterminer où concentrer leur temps et leur énergie.

Publier votre question

Lorsque vous rencontrez un problème avec votre code, vous pouvez être tenté de sauter sur Slack, d'écrire votre problème, d'appuyer sur Envoyer le message, puis copiez votre code et appuyez sur Envoyer encore. Vous voudrez peut-être même écrire une question plus détaillée ou expliquer les solutions que vous avez déjà essayées, puis – oui, vous l'avez deviné – appuyez sur Envoyer encore.

C’est trois messages pour la même question.

Cette approche semble inoffensive et est techniquement possible dans Slack. Mais à quel poste les gens sont-ils censés répondre? La question, le code, ou peut-être le message initial où vous avez posé le problème? C'est vague.

Au lieu de cela, vous devez vous assurer que votre problème, votre question et votre code sont tous contenus dans un post. Cela permet aux utilisateurs de suivre les instructions pour répondre dans un fil succinct plutôt que sur plusieurs fils, ce qui peut entraîner une répétition dans les réponses.

Vous en apprendrez plus sur les meilleures façons de structurer vos questions et de mettre en forme votre code dans un instant. Pour l'instant, tout ce que vous devez savoir, c'est que limiter votre question à un seul article vous sera bénéfique, ainsi que le reste de la Vrai Python Communauté Slack.

Publication croisée

En règle générale, vous devriez essayer d'éviter Publication croisée votre question à plusieurs canaux. La publication croisée peut sembler un moyen efficace d'amener davantage de personnes à voir votre question afin que vous ayez plus de chances d'obtenir une réponse, mais elle a souvent l'effet inverse.

Si les membres vous voient tout le temps une publication croisée, ils peuvent supposer que quelqu'un d'autre a déjà répondu à votre message ailleurs et être moins enclins à répondre. Ou un membre peut prendre un temps considérable pour lire votre code et rédiger une réponse utile, seulement pour constater que votre question a déjà reçu une réponse dans un autre canal.

Il existe une exception à la règle interdisant la publication croisée: si votre question reste sans réponse, et que la raison peut être que vous avez accidentellement publié dans le mauvais canal (nous en reparlerons plus tard), alors ce serait le bon moment pour publier une publication croisée sur un canal approprié.

Si vous vous trouvez dans cette situation, vous devez utiliser le Partager le message fonctionnalité. Cela mettra automatiquement en forme votre question de manière à montrer clairement aux lecteurs qu'il s'agit d'un article croisé, et il renverra au message d'origine afin que les gens puissent répondre au fil de discussion d'origine.

À moins que vous ne remplissiez l'exception ci-dessus, nous vous encourageons à éviter la publication croisée et à publier votre question dans le canal le plus approprié pour votre question.

Trouver la meilleure chaîne pour poser votre question

Il existe plusieurs Slack canaux dans lequel vous pouvez poser des questions. La plupart des chaînes se concentrent sur un sujet ou une spécialité en particulier. Lorsque vous rejoignez Slack, vous serez automatiquement ajouté à quelques chaînes générales. Vous êtes également libre – et encouragé – de rejoindre toutes les chaînes supplémentaires qui existent au sein de la communauté Slack.

Vous pouvez trouver la liste des chaînes disponibles en cliquant sur le + icône à côté du menu Canaux. Sélectionnez la chaîne que vous souhaitez rejoindre et cliquez sur le nom approprié Joindre bouton. Par exemple, vous souhaiterez peut-être rejoindre le #webdev, # science des données, ou #carrières canaux si ces sujets vous intéressent.

Une fois que vous avez rejoint quelques chaînes, vous pouvez poser votre question dans la chaîne la plus étroitement liée à votre problème. Si votre question ne rentre pas dans une catégorie spéciale, alors # coding-questions est la chaîne pour vous.

Communiquer efficacement votre problème

Nous vous encourageons vivement à contacter le Vrai Python communauté chaque fois que vous avez un problème de codage. L'adage selon lequel il n'y a pas de question stupide s'applique très certainement au sein de la communauté. Cependant, il est important que vous communiquiez vos questions de manière claire et succincte.

Pour obtenir la meilleure aide, assurez-vous d'inclure toutes les informations pertinentes dans votre message. Votre question doit contenir quatre parties:

  1. Une description détaillée de ce que vous essayez d'accomplir et du problème que vous avez rencontré
  2. Un résumé des approches que vous avez déjà essayées pour résoudre le problème
  3. Toute réflexion que vous avez sur la nature du problème ou sa cause
  4. Le message de trace ou d'erreur, le code pertinent et toutes les commandes de terminal que vous avez utilisées pour exécuter votre code

L'exécution de cette courte liste de contrôle des informations à inclure dans votre question vous fera gagner du temps et augmentera les chances que les membres puissent vous aider à résoudre votre problème.

Communiquer efficacement votre processus de réflexion et vos problèmes est une compétence et deviendra plus facile à mesure que vous le ferez. Il est donc particulièrement important que, en tant que débutant, vous vous assuriez de poser des questions réfléchies et bien structurées. De cette façon, vous formerez de bonnes habitudes et des relations positives dès le départ.

Rendre votre code plus lisible dans Slack

La possibilité de partager votre code est l’une des plus grandes forces de Slack et en fait une excellente plateforme pour Vrai Python communauté. Il y a trois façons que vous pouvez partager du code formaté sur Slack:

  1. Code en ligne
  2. Blocs de code
  3. Extraits de code

Chacun a son cas d'utilisation et vous devez vous efforcer de respecter les principes énoncés ci-dessous.

Code en ligne

Le code en ligne est le meilleur moyen de formater de petits morceaux de code que vous souhaitez mentionner dans votre question ou vos commentaires. Il n'est pas destiné à être utilisé avec des blocs de code ou des fonctions entiers. Il s'agit principalement de mentionner des variables et objets dans votre question.

Voici un exemple de code en ligne:

Exemple de code en ligne Slack

Les mots Ballon, ModuleNotFoundError, et pip installer le ballon sont formatés sous forme de code en ligne. Le formatage de vos questions de code comme celui-ci ajoute un contexte que les autres membres peuvent utiliser pour analyser rapidement les informations importées.

Pour ajouter du code en ligne à votre question, encapsulez le nom de votre variable ou de votre objet entre des accolades (`) ou cliquez sur Code bouton de mise en forme sur l'éditeur de message.

Blocs de code

Les blocs de code sont une technique de formatage intermédiaire que vous pouvez utiliser pour petits exemples de code comme les fonctions uniques, les sorties REPL et terminaux, et les extraits de codes courts.

Voici un exemple de question qui utilise du code en ligne suivi d'un bloc de code:

Exemple de bloc de code Slack

La question elle-même utilise du code en ligne pour les objets et les noms de variables et est suivie d'un bloc de code affichant le code en question. Pour créer un bloc de code, enveloppez votre code dans des triples back-ticks («  '') ou cliquez sur le bouton Bloc de code bouton (pas le Code bouton!) dans l'éditeur de messages Slack. C'est tout.

Les blocs de code sont mieux utilisés pour afficher dix lignes de code ou moins et ne doivent jamais être utilisés avec du code comportant plus de vingt lignes. Ceci pour plusieurs raisons:

  • Il y a pas de coloration syntaxique, ce qui rend les longs passages de code plus difficiles à lire.
  • Il remplit l'écran au point que les questions des autres membres peuvent être enterrées ou raté.
  • Cela fait un expérience de lecture désagréable pour quiconque parcourt le fil.

Si vous avez besoin de partager de grandes portions de code, il existe un meilleur moyen: des extraits de code!

Extraits de code

Extraits de code, qui ne doivent pas être confondus avec les blocs de code, sont peut-être la fonctionnalité la plus sous-utilisée de Slack. Ils rendent le partage et la lecture de grandes portions de code dans Slack une expérience beaucoup plus agréable. Les extraits de code doivent être votre méthode préférée pour partager la plupart de votre code.

Vous pouvez utiliser à la fois du code en ligne et des blocs de code dans un message d'extrait de code. Ceci est particulièrement utile lorsque vous souhaitez partager votre code et un message d'erreur ou une trace en même temps, ce qui respecte les directives pour garder les questions enveloppées dans un seul message bien formaté.

Voici un exemple d'extrait de code:

Extraits de code dans Slack

L'un des avantages importants de l'utilisation d'extraits de code est qu'ils prennent en charge coloration syntaxique du code pour presque tous les langages de programmation. Ils sont également pliables, ce qui rend les échantillons de code longs moins intrusifs. Les membres intéressés peuvent développer et lire l'extrait de code dans son intégralité en un seul clic.

L'une de mes fonctionnalités préférées des extraits de code est qu'ils sont également téléchargeable. Cela signifie que toute personne qui vous aide à résoudre un problème de codage peut télécharger votre fichier de code et l'ouvrir dans son éditeur de code, ce qui lui permet potentiellement de répliquer votre erreur beaucoup plus facilement. C'est une fonctionnalité vraiment puissante!

Pour créer un extrait de code, cliquez sur l'icône en forme d'éclair dans la zone de message Slack et sélectionnez Créer un texte ou un extrait de code. Cela ouvrira une superposition dans laquelle vous pourrez taper votre question et copier votre code dans la zone de contenu. Vous pouvez donner à l'extrait de code un titre (que vous pouvez traiter comme un nom de fichier) et choisir la langue pour la coloration syntaxique.

Voici une démonstration rapide de la création d'un extrait de code:

Les extraits de code nécessitent quelques étapes de plus que le code en ligne ou les blocs de code, mais ils ont une bien meilleure lisibilité.

Si vous avez d'autres questions sur la mise en forme de votre code dans Slack, faites-le moi savoir dans les commentaires ci-dessous ou contactez-moi sur le Vrai Python Communauté Slack (@Ricky White).

Obtenir des réponses à vos questions

Ne pas obtenir de réponse à votre question peut être frustrant. Si vous constatez que vos questions ne génèrent pas de réponses, il peut être intéressant de vous poser quelques questions pour voir si vous pouvez faire quelque chose pour remédier à cette situation:

  • Combien de temps s'est écoulé?
  • Ai-je inclus toutes les informations pertinentes?
  • Ai-je publié sur la chaîne la plus appropriée?
  • Où puis-je chercher une réponse?

Examinons chacun de ces éléments un peu plus en détail.

Lorsque vous vous demandez combien de temps s'est écoulé, si la réponse n'est que de quelques heures, donnez-lui plus de temps. La plupart des membres ont des emplois à plein temps et ne vérifient Slack que lorsqu'ils ont du temps libre pour travailler sur leurs compétences Python.

Les fuseaux horaires jouent également un rôle clé dans le moment où votre question peut obtenir une réponse. Bien qu’il n’y ait pas de moment propice pour publier des messages, il se peut que vous trouviez une réponse plus rapide aux questions qui sont publiées le soir ou le week-end. Cependant, ne laissez pas cela vous empêcher de publier votre question. Le meilleur moment pour publier est lorsque le problème est frais dans votre esprit.

Auparavant, vous avez expliqué les informations à inclure dans votre question. Si vous n'obtenez pas de réponses, vérifiez s'il y a quelque chose que vous avez oublié. Avez-vous inclus votre traceback ou message d'erreur? Tout le code pertinent est-il inclus et correctement formaté? Tout cela peut affecter la capacité des membres à aider. Il vaut donc la peine de vérifier si vous pouvez réviser votre question et la rendre plus facile à comprendre pour les autres.

Lorsque vous êtes un débutant, il peut être difficile de savoir quelles informations inclure et quoi omettre, et ce n’est pas un problème. Cela deviendra plus facile avec la pratique. Essayez simplement de suivre les consignes ci-dessus et ne laissez pas le doute vous empêcher de publier votre question. le Vrai Python La communauté regorge de personnes accueillantes et généreuses qui mettront tout en œuvre pour vous aider.

Si vous avez attendu suffisamment de temps et que vous êtes sûr que votre question est claire et descriptive, vous pouvez également envisager de poser votre question au bon endroit. Serait-il mieux adapté à un canal différent? Si tel est le cas, publiez-le sur la nouvelle chaîne en utilisant le Partager bouton mentionné précédemment. Cela montrera aux gens où vous avez publié initialement, et ils verront que vous avez toujours besoin d'aide.

Si vous avez épuisé toutes ces options, vous pouvez envisager de poser votre question pendant les heures de bureau réservées aux membres. Si vous ne pouvez pas participer en direct pour poser votre question, vous pouvez partager votre message dans le #heures de travail Slack channel et demandez qu'il soit ajouté à la liste des questions de la session.

Enfin, si aucune des réponses ci-dessus ne donne de résultat, contactez-moi directement dans Slack (@Ricky White) et je peux soit vous aider à trouver une solution, soit vous orienter dans la bonne direction.

Ressources utiles

Si vous souhaitez connaître toutes les options de mise en forme de vos publications et messages, la documentation Slack contient quelques articles pour vous aider. Vous pouvez trouver une aide générale sur la mise en forme dans leur article intitulé Formater vos messages. Si vous souhaitez apprendre des techniques de mise en forme plus avancées, vous pouvez apprendre à utiliser le balisage pour mettre en forme vos messages à la place.

Si vous êtes un débutant, je vous encourage également à consulter Comprendre le suivi de Python. Cela vous aidera à mieux comprendre ce qui se passe dans votre code, ce qui vous aidera à poser de meilleures questions dans la communauté Slack.

Conclusion

Participer à une communauté dynamique comme la Vrai Python Slack peut avoir d'énormes avantages pour votre apprentissage et votre parcours professionnel. Dans ce didacticiel, vous avez appris à commencer à publier dans Slack et à utiliser certaines fonctionnalités moins connues qui peuvent vous aider à tirer le meilleur parti de la communauté.

Apprendre à communiquer vos problèmes techniques est une étape importante pour devenir un développeur compétent. J'espère que ce guide vous aidera à atteindre cet objectif afin que vous puissiez commencer à exploiter Vrai Python vaste base de connaissances des membres.

le Vrai Python La communauté est diversifiée, avec des membres de tous horizons et expériences contribuant de partout dans le monde. Établir des liens avec un réseau de personnes aussi varié vous aidera à améliorer votre compétences techniques, vous exposer à de nouvelles centres d'intérêt, et vous permettre de réseau avec d'autres pythonistes.

La connexion avec vos pairs n'est pas seulement une activité en ligne, comme vous pouvez le voir lors de notre rencontre PyCon 2019:

Tous les participants du Real Python Open Space à PyCon

Si vous n'avez pas encore profité des avantages que la communauté Slack vous offre en tant que Vrai Python membre, vous pouvez créer un compte dès aujourd'hui pour vous connecter avec vos pairs et commencer à faire progresser vos connaissances et votre carrière Python!