Add `CLAUDE.md`

Open Beginner friendly
#691 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
r
Domain
documentation

Research direction

Start by reviewing the agreed CLAUDE.md structure in insightsengineering/nestdevs-tasks#121, then inspect this teal.slice repository for relevant repository-specific context. Add CLAUDE.md at the repository root using the agreed structure and include applicable guidance; done means all three acceptance criteria are met.

Written by the indexing model from the issue text.

Description

core

Description

Add a CLAUDE.md file to this repository to provide repository-specific context and guidance when working with Claude Code.

The structure and expected content for CLAUDE.md are being defined in insightsengineering/nestdevs-tasks#121. The implementation should follow the agreed structure from that issue and adapt the content to this repository.

The CLAUDE.md should capture the relevant repository-specific information while following the common conventions agreed for the teal repositories.

Acceptance criteria

  • CLAUDE.md is added to the repository.
  • The file follows the structure agreed in insightsengineering/nestdevs-tasks#121.
  • Repository-specific guidance is included where relevant.
Dominant language
R
Stars
12
Forks
7
Avg merge
3d 31m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from insightsengineering/teal.slice

All issues in insightsengineering/teal.slice

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.