Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 26 additions & 78 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,43 @@
# Agent Instructions - Branch Protection Workflow
# Agent Instructions - Video Analysis

## ⚠️ IMPORTANT: This repository has branch protection enabled
## ⚠️ READ FIRST: Org-Wide Agent Guide

Direct pushes to `main`/`master` are **BLOCKED**. All changes must go through Pull Requests.
This repo follows Sensible Analytics org-wide standards.

## Required Workflow
**Fetch and follow the org-wide AGENTS.md:**
1. **Local (preferred)**: `~/Business/sensibleAnalytics/.github/AGENTS.md`
2. **Remote**: `https://github.com/Sensible-Analytics/.github/blob/main/AGENTS.md`

### Making Changes
The org-wide guide contains:
- Branch protection rules
- Workflow instructions
- Skill mapping
- Testing standards

1. **Create a feature branch** (never work on main/master):
```bash
git checkout -b feat/your-feature-name
# or
git checkout -b fix/issue-description
```
## 📋 Repo-Specific Notes

2. **Make your changes and commit**:
```bash
git add .
git commit -m "feat: descriptive commit message"
```
Video Analysis is an AI study companion for educational videos.

3. **Push the branch**:
```bash
git push origin feat/your-feature-name
```
### Tech Stack

4. **Create a Pull Request** using the GitHub CLI:
```bash
gh pr create --title "feat: Add new feature" --body "Description of changes"
```
- Framework: Next.js
- Styling: Tailwind CSS
- Backend: Python pipeline
- Deployment: Vercel

5. **Merge after review**:
```bash
gh pr merge --squash --delete-branch
```

### Branch Naming Conventions

- `feat/` - New features
- `fix/` - Bug fixes
- `docs/` - Documentation changes
- `refactor/` - Code refactoring
- `test/` - Test additions/changes
- `chore/` - Maintenance tasks

### What You MUST NOT Do

- ❌ Never push directly to `main` or `master`
- ❌ Never use `git push --force` on protected branches
- ❌ Never delete the `main` or `master` branch
- ❌ Never commit directly without a PR

### Git Configuration

When working with this repository, ensure your git config includes:
```bash
git config user.name "Your Name"
git config user.email "your.email@example.com"
```

## Security Considerations

- All changes go through PR review
- No force pushes allowed
- Branch deletion is prevented
- CI checks should pass before merge

## Quick Reference
### Key Commands

```bash
# Start new work
git checkout -b feat/new-feature
# Dev server
npm run dev

# After making changes
git add . && git commit -m "feat: add new feature"
git push origin feat/new-feature
# Build
npm run build

# Create PR
gh pr create --title "feat: Add new feature" --body "What it does"

# After PR approved
gh pr merge --squash --delete-branch

# Back to main
git checkout main && git pull
# Lint
npm run lint
```

---

## 📄 Governance Documents

- [Code of Conduct](docs/CODE_OF_CONDUCT.md)
- [Security Policy](docs/SECURITY.md)
*For full org-wide rules, see: ~/Business/sensibleAnalytics/.github/AGENTS.md*
Loading