jlevy / jlevy/speculate

Typo in README - broken ref

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
35
Forks
3
PR merge metrics
No merged PRs in 30d

Description

>3. **Create your `development.md`:** ← ⚠️ Don’t forget this step!

> Before pointing agents at your repo, make sure **`docs/development.md`** holds your
> key developer workflow docs.
> You may already have this, or see
> **[`docs/development.npm.sample.md`](docs/development.npm.sample.md)** for an example. Agents read this file first to understand how to build and test your project.

The ref is pointed to sample, but seems [`docs/development.npm.sample.md`]_docs/development.npm.sample.md_

**should be**:

[`docs/development.npm.example.md`]_docs/development.npm.example.md_

Thanks for sharing

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.