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.

Sign up for GitHub

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@ brew install pixee

After installation, run the `pixee` command to see instructions and options.

drdavella marked this conversation as resolved.
Show resolved Hide resolved
## F.A.Q.

### What languages are supported for fixes?
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?

### What happens to my code?
The Pixee CLI currently runs most detection and fixes locally to your own host machine. Any features that require network access to a third-party service (e.g. OpenAI) will require explicit opt-in. We promise to be transparent when this is the case.

### How can I install the GitHub application?
Get the most out of Pixee by installing the Pixeebot GitHub app at https://app.pixee.ai. Or find us on [GitHub Marketplace](https://github.com/apps/pixeebot).

### Where can I request features and report issues?
For CLI feature requests and bug reports please use our GitHub issue tracker: https://github.com/pixee/pixee-cli/issues


## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
Loading