Add golden paths based on policy#338
Draft
gyro2009 wants to merge 2 commits into
Draft
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
golden paths/README.mdthat explains the purpose of the golden paths, links to each guide, and provides context for usage.New Workflow Guides (One per Key Delivery Scenario):
01-start-a-new-repository.mdoutlining steps for creating a new repository with best practices for security, automation, and collaboration.02-deliver-a-code-change.mddetailing the recommended process for making and merging code changes, including traceability, testing, and review.03-release-through-a-pipeline.mddescribing how to define and operate a secure, automated build and release pipeline.04-adopt-or-update-a-dependency.mdspecifying how to safely introduce or update third-party dependencies, with checks for licensing and security.05-document-and-hand-over-a-service.mdand06-handle-defects-security-and-technical-debt.mdcovering 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.