docs: document learning checkpoints and repository branch strategy - #37
Merged
Conversation
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
1 participant
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.
Summary
Documented the purpose of the
Learning Checkpointsdirectory and clarified the branching strategy used throughout the repository.This update explains how checkpoints are used to capture progress, lessons learned, and engineering concepts discovered during the DevSecOps learning journey.
What changed
Added documentation describing the purpose of learning checkpoints.
Defined what each checkpoint contains:
Added a repository branch strategy section.
Clarified that historical branches are intentionally preserved as learning milestones.
Why this change was made
This repository functions as both a DevSecOps laboratory and a learning journal.
Unlike production repositories that prioritize a minimal branch history, this project preserves checkpoint branches and pull requests to document the evolution of understanding across different topics.
Branch examples
checkpoint-10→ GitHub Actions and CIcheckpoint-15→ CodeQL and Trivycheckpoint-18→ Secure CI/CD and branch protectionmonitoring-and-observability→ Prometheus and GrafanaNotes
The branching model used in this repository is intentionally educational and archival in nature. Future production-oriented projects may adopt a simpler feature-branch workflow.