What agents should know before contributing
starship/starship
☄🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
Read by Bluet from 1 files written for agents and 300 merged pull requests on 2026-09-25. Not reviewed by the maintainers.
Rules its files tell agents (3)
- CONTRIBUTING.md
shouldHaving even a single test fail can completely break installation on some platforms, so be careful with tests!
The previous point should be emphasized: even seemingly innocuous ideas like "if we can see the directory, we can read it" or "nobody will have their home directory be a git repo" have bitten us in the past. Having even a single test fail can completely break installation on some platforms, so be careful with tests!
- CONTRIBUTING.md
shouldPlease do not edit these pages directly, even for changes that do not need to be translated (e.g.
Many documentation pages have versions in non-English languages. These translated pages are managed by Crowdin. Please do not edit these pages directly, even for changes that do not need to be translated (e.g. whitespace or emoji changes), since this can cause merges to fail.
- CONTRIBUTING.md
shouldEditor plugins/functionality may help you run these automatically so that you don't accidentally create a PR t…
Editor plugins/functionality may help you run these automatically so that you don't accidentally create a PR that fails.