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

Adding more context to readme #1605

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Adding more context to readme #1605

wants to merge 1 commit into from

Conversation

basiliskus
Copy link
Contributor

Description

Describe what changed in this PR at a high level.

Issue

#1540

Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

1540 - Partially compliant

Fully compliant requirements:

  • Instructions on how to test new assertions from a new branch/PR

Not compliant requirements:

  • Checking for internal open/close quotes in json
  • Making tests fail on purpose as a gut check that they're running as expected/not passing because they're being filtered out
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Missing Information
The PR does not address all the requirements specified in the ticket, particularly checking for quotes in JSON and making tests fail intentionally.

- Set the `AZURE_STORAGE_CONNECTION_STRING` environment variable to the [value in Keybase](keybase://team/cdc_ti/service_keys/TI/staging/azure-storage-connection-string-for-automated-rs-e2e-tests.txt)
- Run the tests:
- `./gradlew rs-e2e:clean rs-e2e:automatedTest`
- From IntelliJ:

Choose a reason for hiding this comment

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

Consider adding a section about how to intentionally make tests fail to check that they are running as expected. This is important for ensuring test reliability. [important]

Copy link

PR Code Suggestions ✨

No code suggestions found for the PR.

Copy link

sonarcloud bot commented Nov 22, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant