[BC-34060] Follow correct versioning practices #27
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation about the gem's submodule versioning strategy to the README. This explains how the gem manages methodology versions to ensure backward compatibility for active pentest engagements.
Key Changes:
- Added a new "Submodule Versioning Strategy" section explaining the versioning approach
- Documented the directory structure pattern and versioning rules
- Explained the rationale for using versioned submodules to prevent breaking changes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
arcwhite
approved these changes
Nov 18, 2025
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.
Description
Document bmt-ruby with correct versioning steps so that existing pentest engagements do not return errors when a step key is updated like reported in this slack thread for example