Structural Explainability Organization (.github repo)

GitHub profile repo for the structural-explainability organization on GitHub.

Developer Command Reference

Show command reference

Install Tools

This repository is not a Python package and does not require a local virtual environment. It does use Python-based command-line tools through uvx, and it uses Node.js for Markdown linting through npx. Install these tools once on your machine:

• uv
• Node.js / npm
• Git

In a machine terminal

Open a machine terminal where you want the project:

git clone https://github.com/structural-explainability/se-codeowners

cd se-codeowners
code .

In a VS Code terminal

Use VS Code Menu: View / Command Palette / Developer: Reload Window to refresh.

uv self update
uvx pre-commit install

# run checks
npx markdownlint-cli2 --fix
uvx pre-commit run --all-files

# generate and check CODEOWNERS
uvx se-codeowners generate --strict --output .github/CODEOWNERS
uvx se-codeowners check

# validate SE manifest file
uvx se-manifest-schema validate-manifest --path SE_MANIFEST.toml --strict

git add -A
uvx pre-commit run --all-files
# repeat if changes were made
uvx pre-commit run --all-files

git commit -m "your message here"
git push -u origin main

# save progress
git add -A
git commit -m "update"
git push -u origin main

# tag as needed (to match CITATION.cff)
git tag vX.Y.Z -m "X.Y.Z"
git push origin vX.Y.Z

Authority Manifest

.accountability/surfaces.toml

Citation

CITATION.cff

License

MIT

Repository Manifest

SE_MANIFEST.toml