Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help message about unit test-suite pattern matching #4846

Merged
merged 9 commits into from
Jan 20, 2024

Conversation

ckeshava
Copy link
Collaborator

@ckeshava ckeshava commented Dec 6, 2023

High Level Overview of Change

This PR updates the help message to reflect the latest state of the codebase. It also renames the unit tests to be more descriptive.

Fix #4800

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (you added tests for code that already exists, or your new feature included in this PR)
  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)
  • Release

API Impact

No changes to the API output.

This PR documents the changes already implemented by #4634 (comment)

The existing unit tests have been renamed. The contents of the tests remain identical.

If needed, use regex for executing unit tests
I'd like more suggestions for the naming of the unit tests. I'm not entirely sure if the names are appropriate.

@ckeshava ckeshava changed the title Issue4800 Update help message about unit test-suite pattern matching Dec 6, 2023
@ckeshava
Copy link
Collaborator Author

@ximinez could you review this PR?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
src/ripple/app/main/Main.cpp Outdated Show resolved Hide resolved
@intelliot intelliot added the Documentation README changes, code comments, etc. label Jan 19, 2024
@intelliot
Copy link
Collaborator

note: this is essentially documentation, so would be fine to include in 2.0.1

@intelliot intelliot added this to the 2.0.1 milestone Jan 19, 2024
Copy link
Collaborator

@gregtatcam gregtatcam left a comment

Choose a reason for hiding this comment

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

👍 LGTM

@intelliot intelliot added the Passed Passed code review & PR owner thinks it's ready to merge. Perf sign-off may still be required. label Jan 20, 2024
@intelliot intelliot merged commit efe6722 into XRPLF:develop Jan 20, 2024
17 checks passed
sophiax851 pushed a commit to sophiax851/rippled that referenced this pull request Jun 12, 2024
…LF#4846)

Update the "rippled --help" message for the "-u" parameter. This
documents the unit test name pattern matching rule implemented by XRPLF#4634.

Fix XRPLF#4800
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation README changes, code comments, etc. Passed Passed code review & PR owner thinks it's ready to merge. Perf sign-off may still be required.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Document unit test name matching and improve unittest names (Version: [2.0.x])
5 participants