Skip to content

Add blueprint and reference implementation guidance docs - #400

Merged
danielgblanco merged 3 commits into
open-telemetry:mainfrom
danielgblanco:extract_template_guidelines
Sep 11, 2026
Merged

danielgblanco merged 3 commits into
open-telemetry:mainfrom
danielgblanco:extract_template_guidelines

Conversation

@danielgblanco

@danielgblanco danielgblanco commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Closes #348

Changes:

  • Extracted advice and guidelines in templates and formatted them as their own docs
  • Extended some advice on blueprints, in particular specific recommended best practices
  • Added a link in issue templates to give visibility

@danielgblanco
danielgblanco requested a review from a team as a code owner September 3, 2026 18:13
@danielgblanco
danielgblanco requested a lite review from Copilot September 3, 2026 18:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Pull request overview

This PR extracts embedded guidance from the blueprint/reference-implementation templates into standalone authoring-guideline docs, and updates GitHub issue templates to point contributors to those guidelines (closing #348).

Changes:

  • Moved template guidance into architecture/blueprint-guidelines.md and architecture/reference-implementation-guidelines.md.
  • Simplified the blueprint and reference-implementation templates to link to the new guideline docs.
  • Updated issue templates to link to the new guidelines for visibility.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
architecture/reference-implementation-template.md Replaces large embedded guidance comment blocks with a link to new authoring guidelines.
architecture/reference-implementation-guidelines.md Adds standalone guidance previously embedded in the reference implementation template.
architecture/blueprint-template.md Replaces embedded guidance comment block with a link to new blueprint authoring guidelines.
architecture/blueprint-guidelines.md Adds standalone guidance previously embedded in the blueprint template, plus extended best practices.
.github/ISSUE_TEMPLATE/reference_implementation.yml Adds a link to the new reference implementation guidelines in the issue form text.
.github/ISSUE_TEMPLATE/blueprint_proposal.yml Adds a link to the new blueprint guidelines in the issue form text.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread architecture/reference-implementation-guidelines.md
Comment thread architecture/reference-implementation-guidelines.md
Comment thread architecture/reference-implementation-guidelines.md
Comment thread architecture/reference-implementation-guidelines.md
Comment thread architecture/reference-implementation-guidelines.md
Comment thread architecture/reference-implementation-template.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread architecture/blueprint-guidelines.md Outdated
@luke6Lh43

Copy link
Copy Markdown
Member

This is a good cleanup, @danielgblanco! It keeps the templates focused, moves detailed guidance into discoverable documents, and links the issue forms to both the template and the authoring guidance. I left one minor wording suggestion; otherwise, this looks good to me.

@AndrejKiri AndrejKiri left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@luke6Lh43

Copy link
Copy Markdown
Member

LGTM!

@danielgblanco
danielgblanco merged commit 89c2750 into open-telemetry:main Sep 11, 2026
5 checks passed
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.

Communicate blueprint and reference implementation guidelines

4 participants