Skip to content

Add more AI rules #4636

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

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

Add more AI rules #4636

wants to merge 1 commit into from

Conversation

adinauer
Copy link
Member

📜 Description

Rules to help AI understand the SDK.
This is mostly intended for development on the SDK.
In the future, we can add more rules that are customer facing too.

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

Copy link
Contributor

Fails
🚫 Please consider adding a changelog entry for the next release.
Messages
📖 Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Add more AI rules ([#4636](https://github.com/getsentry/sentry-java/pull/4636))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description or adding a skip-changelog label.

Generated by 🚫 dangerJS against 185f52b

Copy link
Contributor

@alexander-alderman-webb alexander-alderman-webb left a comment

Choose a reason for hiding this comment

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

None of the comments are blocking, just things I noticed while reading that you can change if there's time.


The samples in the `sentry-samples` directory are used to run end to end tests against them.

There is a python script (`system-test-runner.py`) that can be used to run one (using `--module SAMPLE_NAME`) or all (using `--all` system tests.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There is a python script (`system-test-runner.py`) that can be used to run one (using `--module SAMPLE_NAME`) or all (using `--all` system tests.
There is a python script (`system-test-runner.py`) that can be used to run one (using `--module SAMPLE_NAME`) or all (using `--all`) system tests.


`TestHelper` has a lot of helper methods for asserting, e.g. by span name, log body etc.

The end to end tests either expect the system under test to either be running (for server applications) or call `java -jar` to execute a CLI system under test.
Copy link
Contributor

Choose a reason for hiding this comment

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

This sentence confused me on first read.

Suggested change
The end to end tests either expect the system under test to either be running (for server applications) or call `java -jar` to execute a CLI system under test.
The end to end tests either expect the system under test to either be running on a server or call `java -jar` to execute a CLI system under test.


If `globalHubMode` is enabled, the SDK avoids forking scopes.

This means, retrieving current scopes on a thread where specific scopes for that thread exist yet, the root scopes are not forked but returned directly.
Copy link
Contributor

Choose a reason for hiding this comment

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

I do not understand what is meant here. Does the rewrite below capture the meaning?

Suggested change
This means, retrieving current scopes on a thread where specific scopes for that thread exist yet, the root scopes are not forked but returned directly.
This means, retrieving current scopes on a thread where specific scopes do not exist yet for the thread, the root scopes are not forked but returned directly.

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.

2 participants