Skip to content

docs: Extended developer guideline doc#2219

Draft
thompson-tomo wants to merge 2 commits intoopen-telemetry:mainfrom
thompson-tomo:developer_docs
Draft

docs: Extended developer guideline doc#2219
thompson-tomo wants to merge 2 commits intoopen-telemetry:mainfrom
thompson-tomo:developer_docs

Conversation

@thompson-tomo
Copy link
Copy Markdown
Contributor

@thompson-tomo thompson-tomo commented Apr 13, 2026

Closes #2206

This focuses on providing a detailed developer guide which covers adding, deprecating and removal of gems including the steps needed.

@xuan-cao-swi
Copy link
Copy Markdown
Contributor

A couple of thoughts:

  • Do we actually need both instrumentation/CONTRIBUTING.md and the main CONTRIBUTING.md?
    It might make sense to merge them into a single document and include a table of contents for easier navigation. (example)
  • Similarly, README.md and datadog-porting-guide.md seem to overlap in purpose. Maybe they could be consolidated or reorganized into a more unified structure.

@thompson-tomo
Copy link
Copy Markdown
Contributor Author

I agree about merging the contributing guides but would rather treat them separately to avoid making this PR too big.

In relation to dd migration guide, I am inclined to leave it as is as I suspect it would not often be read. I will think if it can be better incorporated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update development guide

2 participants