Skip to content

improve ai section #13147

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

Closed
ShahakShama wants to merge 1 commit into from
Closed

improve ai section #13147

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
5 changes: 4 additions & 1 deletion style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,16 @@ For single-file modules, they should also start with a `foo_` prefix

## AI-Generated Code Guidelines

Code generated by AI is still your code: You should stand behind every line of code you submit for PR.

Take extra care when reviewing ai-generated code for these issues:

- Using deprecated/dead crates (!): for example `lazy_static` often appears in ai-code (see [lazy static section](#lazy_static-crate)).
- Using deprecated/dead crates (!): for example `lazy_static` often appears in ai-code (see [Unmaintained dependencies](#unmaintained-dependencies)).
- Using "toy" crates (low github-starred, pet‑project crates not intended for production): just because a crate out there can fulfil a given set of requirements doesn't mean it's production-ready, see also [External Dependencies](#external-dependencies) section.
- Excessive code-comment bloat: see [Textual Content Quality](#textual-content-quality) section.
- Hygiene issues: leaks and races are common, since chatbots rarely take a step back and analyze the surrounding conditions in which a code is being run; always analyze flows affected by your change as the AI will not do so.
- Excessive allocations/clones.
- Resolving merge conflicts: AI tends sometimes to just pick our changes without thinking about it.

## Testing

Expand Down
Loading