repository-standards

Files (1)

• SKILL.md

SKILL.md (first lines)

# Repository standards

## Ownership and licensing

Choose an explicit license that matches the owners' intent and the project's dependencies. Preserve upstream notices when modifying or redistributing third-party code. Record source, version, license, and modifications for vendored material. Ask the rights holder before changing the license of an existing project.

## Documentation

Explain what the project does, prerequisites, installation, configuration, tests, and known limits. Keep commands and examples executable or label them as illustrative. Update documentation with behavior and setup changes. Use one authoritative source for each fact and link to it elsewhere.

## Privacy and release hygiene

Keep credentials, private endpoints, user data, local state, generated data, and caches out of version control. Prefer obviously invalid placeholders. Review all changed files and the actual commit contents before publishing. Use a secret scanner or publication gate when available; a clean working tree alone does not prove that history is clean.

## Dependencies

Add only necessary dependencies. Prefer maintained upstream sources and supported installation instructions. Pin versions when reproducibility requires it and keep locks aligned with manifests. Do not imply that unpinned or downloaded artifacts are reproducible.

From Stinocon/pi-workbench, MIT.

More from Stinocon/pi-workbench