Add additional markdown notes#21175
Merged
cgranleese-r7 merged 2 commits intorapid7:masterfrom Mar 26, 2026
Merged
Conversation
adfoster-r7
force-pushed
the
add-additional-markdown-notes
branch
from
70047b7 to
4945509
Compare
adfoster-r7
force-pushed
the
add-additional-markdown-notes
branch
from
4945509 to
d75b082
Compare
h00die
reviewed
Mar 24, 2026
Contributor
h00die
left a comment
h00die
left a comment
There was a problem hiding this comment.
a few things to help guide AI based on work i've done
adfoster-r7
force-pushed
the
add-additional-markdown-notes
branch
2 times, most recently
from
36619c2 to
d081c6e
Compare
adfoster-r7
force-pushed
the
add-additional-markdown-notes
branch
from
d081c6e to
e7eb5f7
Compare
adfoster-r7
force-pushed
the
add-additional-markdown-notes
branch
from
070c58f to
df6c144
Compare
| - `get_version` methods should return a REX version | ||
| - `CheckCode::Vulnerable` is only used when the vulnerability has been exploited | ||
| - `CheckCode::Appears` is only used when the application's versions has been checked` | ||
| - Don't use a massive `<href .*` dot star to grab the version, to be more precise. |
Contributor
There was a problem hiding this comment.
It looks like the HTML code is not rendered with markdown.
Suggested change
| - Don't use a massive `<href .*` dot star to grab the version, to be more precise. | |
| - Don't use a massive `<href .*` dot star to grab the version, to be more precise. |
| ## Coding Conventions | ||
| - Ruby (see `.ruby-version` for the current version). Minimum supported: 3.1+ | ||
| - Follow the project's `.rubocop.yml` configuration — run `rubocop` on changed files before submitting | ||
| - Run `msftidy` to catch common module issues |
Contributor
There was a problem hiding this comment.
Maybe we should be more precise on how to run this too?
ruby tools/dev/msftidy.rb <module_file>
Comment on lines
+84
to
+85
| - Run tests with: `rspec spec/path/to/spec.rb` | ||
| - Use `bundle exec rspec` to ensure correct gem versions |
Contributor
There was a problem hiding this comment.
Maybe these two lines can be merged?
Suggested change
| - Run tests with: `rspec spec/path/to/spec.rb` | |
| - Use `bundle exec rspec` to ensure correct gem versions | |
| - Run tests with `bundle exec rspec spec/path/to/spec.rb` to ensure correct gem versions |
|
|
||
| ## Before Submitting | ||
| - Ensure `rubocop` and `msftidy` pass on any changed files with no new offenses | ||
| - Ensure `msftidy_docs` passes on any changed documentation markdown docs with no new offenses |
Contributor
There was a problem hiding this comment.
Same here:
ruby tools/dev/msftidy_docs.rb <documentation_file>
Contributor
Author
|
Thanks! Will apply the final feedback in a separate PR so we can start testing this a bit sooner |
cgranleese-r7
approved these changes
Mar 26, 2026
adfoster-r7
commented
Mar 26, 2026
| - Don't use `get_`/`set_` prefixes for accessor methods in new code | ||
| - Method parameter names must be at least 2 characters (exception for well-known crypto abbreviations) | ||
|
|
||
| ### Module Development |
Contributor
Author
There was a problem hiding this comment.
Other notes:
- Prefer hash over an array for return values, and use kwargs for reusable APIs for future extensions
- Prefer using
Rex::Versionfor version checks where possible.
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.
Add additional markdown notes for developer tooling
Verification