elastic / elastic/apm-agent-python

[Docs] Better contributing documentation

Ouverte
#769 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
agent-python
Langage dominant
Python
Étoiles
431
Forks
239
Merge moyen
5 j 10 h
PR mergées (30 j)
7

Description

Ref #681

Our contributing documentation is a bit lacking. Specifically, it would be nice to have a document that gives a tour of where the various pieces of the code are, how some of the inheritance paths work, and maybe pull some of the instructions from [Beni's old blog post](https://www.elastic.co/blog/creating-custom-framework-integrations-with-the-elastic-apm-python-agent) into our documentation proper.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par lire la documentation actuelle sur la contribution ainsi que l’article de blog de Beni, lié dans celle-ci, sur la création d’intégrations personnalisées de frameworks. Regroupez la visite guidée du code demandée, les chemins d’héritage et les instructions d’intégration dans un document unique destiné aux contributeurs. Le travail est considéré comme terminé lorsque les contributeurs peuvent trouver les principales zones du code, comprendre l’héritage pertinent et suivre les instructions d’intégration documentées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.