docs: updated AI onboarding instructions#137
Open
iloveagent57 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates docs/developing-with-ai.md to refresh AI onboarding guidance for this repository, focusing on Claude Code usage, recommended settings, and team tips to improve the out-of-the-box developer experience.
Changes:
- Removes the prior “Quick Reference” section (skills/key files) and expands the doc with “How We Use Claude”.
- Adds a sample
~/.claude/settings.jsonconfiguration and explanations for key settings. - Adds “Team Tips”, including a sample global
~/.claude/CLAUDE.mdblock.
| ## How We Use Claude | ||
|
|
||
| ### MCP Servers to Activate | ||
| - [ ] github — GitHub API access for reading PRs, issues, and code. Request access via your standard GitHub org membership; configure via `/mcp` in Claude Code. |
Comment on lines
+39
to
+41
| ### Skills from our plugins | ||
| See the `ai-devtools-internal` instructions above for information about available plugins and skills that are tailored | ||
| for use in the edX development environment. |
| "edx-enterprise-team-marketplace": { | ||
| "source": { | ||
| "source": "directory", | ||
| "path": "/Users/YOUR_USERNAME/code/ai-devtools-internal" |
Comment on lines
+87
to
+89
| - **`~/.claude/CLAUDE.md`**: your personal global instructions file — Claude loads it in every session across every project. Use it to set your coding principles, communication style, and any habits you want Claude to apply everywhere. Here's Alex's as a starting point: | ||
| - Use `/compact` and `/clear` regularly. | ||
| - Use the `/statusline` command to configure claude code to display your current usage and context size. |
iloveagent57
force-pushed
the
aed/ai-onboarding-update
branch
from
467ff84 to
04e95ff
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #137 +/- ##
=======================================
Coverage 85.90% 85.90%
=======================================
Files 109 109
Lines 6747 6747
Branches 832 832
=======================================
Hits 5796 5796
Misses 822 822
Partials 129 129 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updates the AI onboarding doc based on the claude
/onboardingcommand output, the goal is to helpother devs get a good, out-of-the-box AI experience based on known good example configuration (my own).