Skip to content

Add golden paths based on policy#338

Draft
gyro2009 wants to merge 2 commits into
mainfrom
gyro2009/add-golden-paths
Draft

Add golden paths based on policy#338
gyro2009 wants to merge 2 commits into
mainfrom
gyro2009/add-golden-paths

Conversation

@gyro2009

Copy link
Copy Markdown
Contributor

This pull request introduces a new set of "Golden Paths" guides, providing concrete, opinionated workflows for common software engineering activities. These guides are designed to help teams follow best practices efficiently by translating policy into actionable steps, including anti-patterns and exit criteria for each workflow. The changes are primarily the addition of new markdown documentation files, each focused on a key delivery scenario.

The most important changes are:

Introduction of Golden Path Documentation:

  • Added a new golden paths/README.md that explains the purpose of the golden paths, links to each guide, and provides context for usage.

New Workflow Guides (One per Key Delivery Scenario):

  • Added 01-start-a-new-repository.md outlining steps for creating a new repository with best practices for security, automation, and collaboration.
  • Added 02-deliver-a-code-change.md detailing the recommended process for making and merging code changes, including traceability, testing, and review.
  • Added 03-release-through-a-pipeline.md describing how to define and operate a secure, automated build and release pipeline.
  • Added 04-adopt-or-update-a-dependency.md specifying how to safely introduce or update third-party dependencies, with checks for licensing and security.
  • Added 05-document-and-hand-over-a-service.md and 06-handle-defects-security-and-technical-debt.md covering best practices for service documentation, handover, defect management, and technical debt handling. [1] [2]

These additions provide clear, actionable guidance for teams to follow, helping ensure consistency, compliance, and quality across common engineering workflows.

@snyk-io-eu

snyk-io-eu Bot commented Jul 14, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

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.

1 participant