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

Add FAQ #4

Merged
merged 1 commit into from
Dec 14, 2023
Merged

Add FAQ #4

merged 1 commit into from
Dec 14, 2023

Conversation

drdavella
Copy link
Member

No description provided.

@drdavella drdavella requested review from matt- and nahsra December 13, 2023 21:28
README.md Show resolved Hide resolved

### What languages are supported?
Currently we support codemods for Java and Python. Stay tuned for additional language support at https://pixee.ai!

Copy link
Contributor

Choose a reason for hiding this comment

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

Given that we're going to do this imminently, it feels like we should just mention it directly here. How's something like this?

The vast majority of analysis and code transformation occurs locally to your own host machine. Some features may require sending limited code snippets to OpenAI as a subprocessor. To enable these additional features, please set an `OPENAI_API_KEY` environment variable before running.

This is all confusing enough that it may be better to just say nothing -- after all, if we can't do something because we don't have an OpenAI key present, should we just warn the user at stdout at that time?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this feature needs to be opt-in from the CLI (for codemodder too) and we should be explicit about when it occurs. I don't think we can assume just because an OPENAI_API_KEY is defined that the user is okay with us spending their money and/or sending their code implicitly. Also I don't think we want to be specific about a particular vendor here since we may at some point send data to other vendors and/or our own services.

Copy link
Contributor

Choose a reason for hiding this comment

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

we should be explicit about when it occurs. I don't think we can assume just because an OPENAI_API_KEY

Do you take it as implied consent if we only honor a PIXEE_OPENAI_API_KEY?

Also I don't think we want to be specific about a particular vendor here since we may at some point send data to other vendors and/or our own services.

I've seen lots of sites now that ask me to acknowledge OpenAI as a subprocessor and consent to sending data to them.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes that feels more like a proper opt-in to me. Is it okay to keep this text relatively general for now and then update to mention OpenAI later once those features are available?

README.md Outdated Show resolved Hide resolved
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@drdavella
Copy link
Member Author

I'm taking the liberty of merging this PR (with new updates) but we can make additional changes at any point.

@drdavella drdavella merged commit fb4d1d2 into main Dec 14, 2023
3 checks passed
@drdavella drdavella deleted the add-faq branch December 14, 2023 18:41
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