-
-
Notifications
You must be signed in to change notification settings - Fork 131
Sdc ai guidance #1931
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
Merged
Merged
Sdc ai guidance #1931
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
2588b52
initial ai guidance for sdc
Poonam-raj 0bb72dd
add ai guide to sdc tools prep
Poonam-raj 050e506
correct layout of ai guide sdc
Poonam-raj bb9ab9f
Update common-content/en/module/tools/sdc-ai-use/index.md
Poonam-raj 112e9cb
Update common-content/en/module/tools/sdc-ai-use/index.md
Poonam-raj 1255349
phrasing edits
Poonam-raj 79e9d91
Merge branch 'main' of https://github.com/CodeYourFuture/curriculum i…
Poonam-raj 497efa5
Merge branch 'sdc-ai-guidance' of https://github.com/CodeYourFuture/c…
Poonam-raj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| +++ | ||
| title="Acceptable AI Use" | ||
| time=5 | ||
| objectives = [ | ||
| "Explain acceptable and unacceptable uses of AI during the SDC.", | ||
| "Recognise how to check whether your AI use is appropriate or not for the SDC." | ||
|
|
||
| ] | ||
| [build] | ||
| render = 'never' | ||
| list = 'local' | ||
| publishResources = false | ||
| +++ | ||
|
|
||
| By the SDC, you have the foundational understanding needed to use AI more actively because you can now evaluate and challenge what it produces. This is where learning to use AI as a professional tool becomes part of your training. Your responsibility does not change. You must be able to **explain, modify, debug, and defend any code you submit**, regardless of whether AI helped produce it. | ||
|
Poonam-raj marked this conversation as resolved.
Outdated
|
||
|
|
||
| To read the full AI guidelines for trainees please see here: [AI Use Guidelines for Trainees](/ai-use-guidelines). This page is the SDC-specific guidance for AI use. | ||
|
Poonam-raj marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### AI IS appropriate for: | ||
|
Poonam-raj marked this conversation as resolved.
Outdated
|
||
|
|
||
| - Exploring architectural approaches and trade-offs ("What are the pros and cons of approach A vs B for this problem?") | ||
| - Generating repetitive code that you already understand and could write yourself. | ||
| - Reviewing and improving code you have already written. _Example prompts: “Here is my code. What improvements could make it more readable or maintainable?”_ | ||
|
Poonam-raj marked this conversation as resolved.
Outdated
|
||
| - Identifying potential edge cases you might not have considered, after you have already attempted to think through them yourself. | ||
| - Using AI APIs to build ambitious project features | ||
|
|
||
| #### Always required: | ||
|
|
||
| - You must be able to explain all code in your submissions | ||
| - You must be able to modify and debug AI-generated code independently | ||
| - Treat AI like a colleague whose work you are responsible for reviewing, not an authority whose output you submit unchecked | ||
|
|
||
| > [!IMPORTANT] | ||
| > | ||
| > ##### You must ensure you are still learning: | ||
| > | ||
| > At this stage, you can use AI more actively, but check yourself: | ||
| > | ||
| > Are you asking AI to do things you could do yourself but want done faster (good productivity use), or things you couldn't do yourself (sign you're skipping learning)? | ||
| > | ||
| > **The repetition test still applies:** If you'll need AI to do the same type of task next time, you haven't learned enough yet. | ||
|
|
||
| #### Using AI for code review: | ||
|
|
||
| Ask AI to review your code rather than write new code. Frame it like this: | ||
|
|
||
| - "Here is my code [paste]. What might I be missing? What edge cases should I consider?" | ||
| - "Here is my code [paste]. How could I improve its readability without changing what it does?" | ||
| - "Explain the security implications of this approach [paste]." | ||
|
|
||
| {{<multiple-choice | ||
| question="What is NOT an example of acceptable use of AI in the SDC?" | ||
| answers="Here is my code. What improvements could make it more readable or maintainable? | Explain the security implications of this approach [paste]. | Here's the task, generate a a function that passes the requirements." | ||
| feedback="This is actually a good way to use AI to improve code you've already written. | This prompt is a good way to check how you could improve your approach to be more secure. | Correct, this is an unacceptable way to use AI, you skip the problem solving and understanding aspects of the work - both are important to your learning." | ||
| correct="3" >}} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.