Skip to content

Add additional markdown notes#21175

Open
adfoster-r7 wants to merge 2 commits intorapid7:masterfrom
adfoster-r7:add-additional-markdown-notes
Open

Add additional markdown notes#21175
adfoster-r7 wants to merge 2 commits intorapid7:masterfrom
adfoster-r7:add-additional-markdown-notes

Conversation

@adfoster-r7
Copy link
Contributor

Add additional markdown notes for developer tooling

Verification

  • Ensure CI works
  • Proof read and suggest any improvements to make

This comment was marked as outdated.

@adfoster-r7 adfoster-r7 force-pushed the add-additional-markdown-notes branch from 4945509 to d75b082 Compare March 24, 2026 16:22
Copy link
Contributor

@h00die h00die left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few things to help guide AI based on work i've done

@adfoster-r7 adfoster-r7 force-pushed the add-additional-markdown-notes branch 2 times, most recently from 36619c2 to d081c6e Compare March 24, 2026 16:35
@adfoster-r7 adfoster-r7 force-pushed the add-additional-markdown-notes branch from d081c6e to e7eb5f7 Compare March 24, 2026 20:17
@adfoster-r7 adfoster-r7 force-pushed the add-additional-markdown-notes branch from 070c58f to df6c144 Compare March 25, 2026 13:12
- `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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here:

ruby tools/dev/msftidy_docs.rb <documentation_file>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

5 participants