Courseware / Claude AI / course-047
Boris Cherny: "My job is to write loops." 5-day version you can copy for Claude Code Day 1: repo memory - write CLAUDE.md - include stack, test commands, code style, release rules, gotchas - add .claude/settings.json with the shell commands Claude can run Day 2: verification
Tweet@alphabatcherView Source →

🎙 Podcast Version

2-host dialogue — ALEX & SAM discuss this course.

Course Title: Becoming a Claude Code Contributor

=================================================

Overview

In this comprehensive course, you will learn how to set up a local development environment and contribute code to the Claude project, following a 5-day onboarding process designed by Boris Cherny. By the end of this course, you will have a solid understanding of Claude's architecture, testing, and release procedures, enabling you to make meaningful contributions to the project.

Background & Context

Claude is an open-source project developed and maintained by a community of contributors. The project's success depends on the active participation of individuals who are passionate about writing loops and improving the platform. By following this course, you will join the ranks of these contributors, helping to shape the future of Claude.

Core Concepts

Claude Repository Memory

In the context of Claude development, "repo memory" refers to the documentation of essential information within the project's repository. This documentation includes the tech stack, testing commands, code style guidelines, release rules, and known "gotchas" or potential issues that may arise during development. Maintaining accurate and up-to-date repo memory ensures a consistent development experience for all contributors.

CLAUDE.md

CLAUDE.md is a crucial file in the Claude repository, serving as a central hub for all essential information about the project. It typically includes:

  1. Tech stack: A list of technologies, libraries, and tools used in the Claude project.
  2. Test commands: The commands required to run automated tests, ensuring code quality and functionality.
  3. Code style guidelines: A set of rules and best practices to maintain a consistent coding style across the project.
  4. Release rules: Guidelines for releasing new versions of the Claude software, including versioning schemes and release frequency.
  5. Gotchas: A list of potential issues or "gotchas" that contributors should be aware of when working on the project.

.claude/settings.json

The .claude/settings.json file contains shell commands that Claude, the project's AI, is allowed to execute. This file is essential for setting up Claude's permissions and ensuring secure interactions with the development environment.

How It Works / Step-by-Step

Follow this 5-day onboarding process to set up your local development environment and learn the ins and outs of Claude:

Day 1: Repo Memory

  1. Create CLAUDE.md: Begin by creating a new file named CLAUDE.md in the root directory of the Claude repository.
  2. Document the tech stack, test commands, code style, release rules, and gotchas: Based on your exploration of the Claude repository, document all relevant information in the CLAUDE.md file.
  3. Create .claude/settings.json: Create a new file named settings.json within the .claude directory. Add the shell commands that Claude is allowed to run.

Day 2: Verification

Details regarding Day 2 will be provided in a follow-up video by Boris Cherny (video URL: [blob:https://x.com/16e4a746-fec5-4159-a98f-bd887ae4d311](blob:https://x.com/16e4a746-fec5-4159-a98f-bd887ae4d311)).

Real-World Examples & Use Cases

  1. Contributing a new feature: Suppose you've identified a missing feature in Claude that would improve its functionality. By following this onboarding process, you'll be well-equipped to implement the feature, write tests, and release a new version of Claude with your contribution.
  2. Fixing a bug: If you discover a bug while using Claude, you can use the knowledge gained from this course to identify the issue, fix it, and submit a pull request to the project's maintainers.

Key Insights & Takeaways

  • Maintaining accurate repo memory is crucial for a consistent development experience.
  • Understanding the tech stack, testing procedures, and code style guidelines is essential for contributing to the Claude project.
  • The .claude/settings.json file is crucial for setting up Claude's permissions and ensuring secure interactions with the development environment.

Common Pitfalls / What to Watch Out For

  • Neglecting to update the CLAUDE.md file as the project evolves may lead to inconsistencies and confusion among contributors.
  • Failing to adhere to the project's code style guidelines may result in code rejections or delays in the review process.

Review Questions

  1. What is the purpose of the CLAUDE.md file, and what information does it typically contain?
  2. Explain the role of the .claude/settings.json file in the Claude development process.
  3. Describe a scenario where the knowledge gained from this course would be helpful in contributing to the Claude project.

Further Learning

  • Learn more about open-source development best practices.
  • Explore advanced topics in Claude AI, such as natural language processing, machine learning algorithms, and integration with other platforms.
  • Connect with the Claude community to collaborate on new features, share insights, and stay up-to-date on the latest developments in the project.
← Previous
Next →