elastic / elastic/apm-agent-python

[Docs] Better contributing documentation

Open
#769 0 comments 0 reactions 0 assignees View on GitHub
agent-python
Dominant language
Python
Stars
431
Forks
239
Avg merge
5d 10h
Merged PRs (30d)
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.

Contributor guide

Open the contributing guide

Research direction

Start by reading the current contributing documentation and Beni's linked blog post about creating custom framework integrations. Map the requested code tour, inheritance paths, and integration instructions into a single contributor-facing document. Done means contributors can find the main code areas, understand the relevant inheritance, and follow the documented integration guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.