Skip to content

Commit 251de65

Browse files
committed
docs: update README with fork status and agent development info
Why: README needed clarity on fork status and agent-assisted development Approach: Cleaned up status section, added agent info to Contributing Learned: Keep focus on otel-cli as great CLI tool for OTEL signals Next: Push and update PR Changes: - Replaced rambling status with clear fork statement - Added 'Amy & the bots' as active maintainers - Documented agent-assisted development starting v0.6.0 - No MCP mention - otel-cli stays focused on CLI excellence - Improved Contributing section with agent and human guidance - Cleaned up contact information and links - Updated License section for clarity 🤖 Claude <[email protected]>
1 parent 40525c9 commit 251de65

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
1-
# PROJECT STATUS UPDATE
1+
# PROJECT STATUS
22

3-
This is a fork of the original otel-cli project that I will eventually rename.
3+
This is a fork of the original otel-cli project, actively maintained by **Amy & the bots** 🤖
44

5-
It's 100% Apache 2 code so this seems fine to do. I made attempts to maintain
6-
under the equinix-labs umbrella, but it seems some of the changes at the company
7-
have slowed progress on that effort.
5+
Built originally by A. Tobey while at Equinix Metal, this fork continues development with a focus on being a great command-line tool for OpenTelemetry signals. Starting with v0.6.0, development uses agent-assisted workflows to maintain code quality while preserving the project's philosophy.
86

9-
After doing some work on the tool today, I will probably rename it soon, and
10-
break ties with the original tool. Please open issues or discussions if you
11-
have thoughts and desires for otel-cli.
7+
The project is 100% Apache 2 licensed code. Development is tracked via GitHub issues and pull requests.
128

13-
Primarily I intend to explore an MCP implementation that is lean and easy to
14-
run anywhere, with no fuss, to tap into traces in my development loop.
15-
16-
I turned on GitHub discussions, please use them to get in touch, or find
17-
me on Bluesky at `@renice.bsky.social`.
9+
**Get in touch:**
10+
- 📋 [Open an issue](https://github.com/tobert/otel-cli/issues) for bugs or features
11+
- 💬 [Start a discussion](https://github.com/tobert/otel-cli/discussions) for ideas and questions
12+
- 🦋 Find Amy on Bluesky: [@renice.bsky.social](https://bsky.app/profile/renice.bsky.social)
1813

1914
# otel-cli
2015

@@ -302,7 +297,19 @@ go run . span -n "testing" -s "my first test span"
302297

303298
## Contributing
304299

305-
Please file issues and PRs on the GitHub project at https://github.com/tobert/otel-cli
300+
We welcome contributions! This project uses agent-assisted development starting with v0.6.0.
301+
302+
**For agents working on this codebase:**
303+
- See [BOTS.md](BOTS.md) for comprehensive agent development guidance
304+
- CLAUDE.md and GEMINI.md symlink to BOTS.md for model-specific access
305+
- Emphasize functional testing in `main_test.go`
306+
- Commit freely in branches, squash on merge to main
307+
308+
**For human contributors:**
309+
- File [issues](https://github.com/tobert/otel-cli/issues) for bugs or feature requests
310+
- Submit PRs with clear descriptions
311+
- See [TESTING.md](TESTING.md) for testing guidance
312+
- Follow the existing Go code style
306313

307314
## Releases
308315

@@ -327,5 +334,7 @@ goreleaser release --rm-dist
327334

328335
## License
329336

330-
Apache 2.0, see LICENSE
337+
Apache License 2.0 - Copyright (c) 2025 A. Tobey
338+
339+
See [LICENSE](LICENSE) for full details.
331340

0 commit comments

Comments
 (0)