✨ Resources ✨

Using Git

Design Critiques

Code Reviews

Learning Through Reflection

Writing a CLAUDE.md or AGENTS.md File

Standing instructions for coding agents can be written to a file named AGENTS.md (works with any AI agent) or CLAUDE.md (specific to Claude). Items to include in these could be your coding experience, what tools to use, or what commands to never run.

Shriram provided these items that are in his CLAUDE.md (your choices may vary):

- Please read and follow this CLAUDE.md, and update it whenever you get new
  instructions.

- Assume I am an experienced computer programmer and computer scientist:
  speak to me accordingly.

- Implement everything in TypeScript with proper types (minimize/entirely avoid
  any, for instance).

- The workflow for each feature/fix is as follows:
  - create a new git branch
  - work in that git branch
  - when I confirm that we're done:
    - check in the files added/modified
    - make sure all the relevant files have been added
    - commit
    - switch back to main
    - merge the branch into main
    - delete the new branch
    - push

- NEVER use git -A. Only commit files that you have created or modified. If in
  doubt, check with me before adding a file.

- Try to write purely functional code as much as possible.

- Make sure you have good tests. Use a testing harness. Before claiming that a
  feature is done, add tests for that feature.

- Follow a model-view architecture so that you can test the models and functions
  extensively, even if the UI isn't very tested.

- You should use a combination of Bootstrap and Racket Pollen. We are using
  Pollen for two reasons: (1) Because it's more pleasant to author in than raw
  HTML, and (2) because it's far more powerful than, say, Jekyll. For instance,
  we will want to have tables of information in the middle of the page, and
  instead of editing those raw, we can use a CSV (and a preferred editor) to
  create the table, and you can use Pollen to turn it into HTML and style it
  prettily. So please use Pollen.

Here's a post from the github blog with an example of specific sections to put in an AGENTS.md file. Just scroll down far enough to see the ''Example of a great agent.md file'' box with the blue/gray background.