Skip to content

contributing docs#6

Merged
maryliag merged 12 commits into
open-telemetry:mainfrom
maryliag:contrib-doc
Jun 25, 2026
Merged

contributing docs#6
maryliag merged 12 commits into
open-telemetry:mainfrom
maryliag:contrib-doc

Conversation

@maryliag

Copy link
Copy Markdown
Contributor

add documentation on how to contrib/use. Make improvements on existing workflows

Copilot AI review requested due to automatic review settings June 25, 2026 14:16
@maryliag maryliag requested a review from a team as a code owner June 25, 2026 14:16

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.

Pull request overview

This PR adds contributor-facing documentation to the shared-workflows repository and makes incremental improvements to the existing security workflows. It introduces a top-level CONTRIBUTING.md and a .github/workflows/README.md that explain the two supported workflow shapes (reusable uses:-style vs. centrally-executed), wires a workflows catalog table into the main README.md, and hardens the zizmor, codeql, and scorecard workflows with job names, concurrency controls, and clearer permission comments. The zizmor workflow is also made reusable via workflow_call with usage documentation.

Changes:

  • Adds CONTRIBUTING.md and .github/workflows/README.md documenting the contribution process and workflow layout conventions; adds a workflows catalog table to README.md.
  • Makes zizmor.yml a reusable workflow (workflow_call), adds a usage header comment, sets persona: pedantic, and adds job naming/concurrency.
  • Adds concurrency groups and job names to codeql.yml and scorecard.yml, and inlines permission-rationale comments.

Reviewed changes

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

Show a summary per file
File Description
README.md Adds a link to CONTRIBUTING.md and a Workflows catalog table listing the reusable Zizmor workflow.
CONTRIBUTING.md New guide covering proposing/using shared workflows, layout conventions, and code ownership.
.github/workflows/README.md New directory README explaining the two workflow shapes and where supporting files live.
.github/workflows/zizmor.yml Adds workflow_call, usage header, concurrency, job name, and persona: pedantic.
.github/workflows/codeql.yml Adds a job-level concurrency group (collides across matrix entries — see comment).
.github/workflows/scorecard.yml Adds job name, concurrency, and consolidates permission comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/codeql.yml Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread .github/workflows/README.md Outdated
Comment thread .github/workflows/codeql.yml Outdated
Comment thread .github/workflows/zizmor.yml

@trask trask left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks!

@maryliag maryliag merged commit b87e157 into open-telemetry:main Jun 25, 2026
5 checks passed
@maryliag maryliag deleted the contrib-doc branch June 25, 2026 19:29
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.

3 participants