Skip to content

github_repository_settings.md

Latest commit

 

History

History
216 lines (146 loc) · 4.56 KB

github_repository_settings.md

File metadata and controls

216 lines (146 loc) · 4.56 KB
Raw

GitHub Repository Settings

Use this checklist immediately after creating the GitHub repository.

Screenshot review and redaction guidance lives in:

docs/github_repository_settings_screenshot_checklist.md

Name

fde-ai-systems-portfolio

Description

Three runnable enterprise AI systems showing secure RAG, governed agents, AI release reliability, evals, traces, audit logs, and approval gates.

Website

Leave blank until a hosted demo or project page exists.

Topics

ai-agents
rag
llm-evals
enterprise-ai
forward-deployed-engineering
openai
responses-api
agentic-workflows
tool-calling
human-in-the-loop
ai-safety
python

Repository metadata troubleshooting examples live in:

docs/github_repository_metadata_troubleshooting_examples.md

Social Preview

Use:

docs/assets/github-preview.png

The SVG source is also kept at docs/assets/github-preview.svg.

Troubleshooting examples live in:

docs/social_preview_verification_examples.md

Branch Protection

Recommended for main after the first push:

  • require pull request before merging
  • require status checks before merging
  • require quality-gate to pass
  • require branches to be up to date before merging
  • disallow force pushes

Automated path after gh auth login:

python -B scripts/maintain_github_state.py --apply --skip-release

The maintenance script delegates launch setup to scripts/configure_github_launch.py and also provides the guarded PR-maintenance path. Secret scanning and push protection are best effort because availability can depend on account and repository security settings.

Authenticated maintenance troubleshooting examples live in:

docs/github_authenticated_maintenance_troubleshooting_examples.md

The branch-protection API payload is tracked in:

docs/github_branch_protection.json

The payload expects code-owner review coverage from:

.github/CODEOWNERS

Dependency Monitoring

Dependabot version updates are tracked in:

.github/dependabot.yml

Verification examples live in:

docs/dependabot_secret_scanning_verification_examples.md

After publishing, enable the repository security features available in the GitHub UI:

  • Dependabot alerts
  • Dependabot security updates
  • secret scanning and push protection, if they were not already enabled by python -B scripts/maintain_github_state.py --apply

Labels And Community Issues

Repository labels are tracked in:

docs/github_labels.json

Troubleshooting examples live in:

docs/github_label_troubleshooting_examples.md

Validate labels, issue templates, and the community issue pack with:

python -B scripts/dev.py community-issues

Dry-run GitHub label sync:

python -B scripts/manage_community_issues.py

After gh auth login, sync labels without creating roadmap issues:

python -B scripts/manage_community_issues.py --apply

Create community issues only when the repository is intentionally ready to show open roadmap work:

python -B scripts/manage_community_issues.py --apply --create-issues

First Release

Automated path after gh auth login:

python -B scripts/dev.py replay-artifact
python -B scripts/maintain_github_state.py --apply

The apply path creates or verifies the v0.1.0 release page and uploads the current out/demo_replay_artifact.md and out/demo_replay_artifact.json attachments. It fails fast if those generated artifacts are missing.

Manual release details if using the GitHub UI:

Create release:

v0.1.0

Release title:

FDE AI Systems Reference v0.1.0

Release notes:

Initial public release with three local-first enterprise AI systems:

- Secure Enterprise Knowledge Copilot for permission-aware RAG.
- Regulated Customer Operations Agent for governed tool-calling workflows.
- AI Reliability Incident Console for release eval regression and rollout triage.

Verified locally:

- Project 1 evals: 11/11 passed, unsafe leaks 0.
- Project 2 evals: 8/8 passed, unsafe direct side-effect failures 0.
- Project 3 evals: 6/6 passed, unsafe release approval failures 0.
- Smoke tests: 13/13 passed.
- Quality gate: passed.

Profile Pin

Pin this repository only after:

  • GitHub Actions is green.
  • README desktop and mobile screenshots render correctly.
  • repo topics are set.
  • static badge is replaced with the real Actions badge.

Profile pin troubleshooting examples live in:

docs/profile_pin_verification_examples.md