Initial commit: add .gitignore and README

This commit is contained in:
defiQUG
2026-02-09 21:51:44 -08:00
commit 97691fdcb7
3 changed files with 192 additions and 0 deletions

49
.gitignore vendored Normal file
View File

@@ -0,0 +1,49 @@
# Dependencies
node_modules/
.pnpm-store/
vendor/
# Package manager lock files (optional: uncomment to ignore)
# package-lock.json
# yarn.lock
# Environment and secrets
.env
.env.local
.env.*.local
*.env.backup
.env.backup.*
# Logs and temp
*.log
logs/
*.tmp
*.temp
*.tmp.*
# OS
.DS_Store
Thumbs.db
# IDE
.vscode/
.idea/
*.swp
*.swo
*~
# Build / output
dist/
build/
.next/
out/
*.pyc
__pycache__/
.eggs/
*.egg-info/
.coverage
htmlcov/
# Optional
.reports/
reports/

85
README.md Normal file
View File

@@ -0,0 +1,85 @@
# Governance Automation Scripts
**Version**: 1.0
**Date**: 2025-01-27
**Purpose**: Automation scripts for governance processes
---
## Available Scripts
### proposal_id_generator.sh
**Purpose**: Generate proposal IDs and create proposal files from template
**Usage**:
```bash
./proposal_id_generator.sh [system]
```
**Examples**:
```bash
# Generate proposal ID and create file
./proposal_id_generator.sh
# Generate proposal ID for specific system
./proposal_id_generator.sh dbis
./proposal_id_generator.sh iccc
./proposal_id_generator.sh smom
```
**What it does**:
1. Generates proposal ID in format: `PROPOSAL-YYYY-MMDD-NNN`
2. Creates proposal file from template
3. Updates placeholder values
4. Places file in `proposals/active/` directory
**Requirements**:
- Template must exist at `../CANONICAL_PROPOSAL_TEMPLATE.md`
- `proposals/active/` directory must exist
- Bash shell with standard utilities
---
## Future Automation Opportunities
### Proposal Tracking
- Automated tracking entry creation
- Status update automation
- Deadline reminder automation
### Compliance Checking
- Pre-submission checklist validation
- Link verification
- Template compliance checking
### Documentation Updates
- Auto-update amendment log (if constitutional)
- Auto-version increment
- Auto-date updates
### Notification Automation
- Automated proposal submission notifications
- Deadline reminder automation
- Status update notifications
---
## Script Development Guidelines
### Standards
- Use bash or appropriate scripting language
- Include error handling
- Provide usage instructions
- Document requirements
- Test scripts before deployment
### Documentation
- Include README for each script
- Document usage examples
- List requirements
- Note any dependencies
---
**Last Updated**: 2025-01-27

58
proposal_id_generator.sh Executable file
View File

@@ -0,0 +1,58 @@
#!/bin/bash
# Proposal ID Generator
# Generates proposal IDs in format: PROPOSAL-YYYY-MMDD-NNN
# Usage: ./proposal_id_generator.sh [system]
# Example: ./proposal_id_generator.sh dbis
set -e
# Get current date components
YEAR=$(date +%Y)
MONTH=$(date +%m)
DAY=$(date +%d)
DATE_STR="${YEAR}-${MONTH}${DAY}"
# Proposal directory
PROPOSAL_DIR="../proposals/active"
# Count existing proposals for today
EXISTING=$(find "$PROPOSAL_DIR" -name "PROPOSAL-${DATE_STR}-*.md" 2>/dev/null | wc -l)
SEQUENCE=$(printf "%03d" $((EXISTING + 1)))
# Generate proposal ID
PROPOSAL_ID="PROPOSAL-${DATE_STR}-${SEQUENCE}"
# Optional: System parameter
SYSTEM=${1:-""}
echo "Generated Proposal ID: $PROPOSAL_ID"
# Create proposal file from template
TEMPLATE="../CANONICAL_PROPOSAL_TEMPLATE.md"
PROPOSAL_FILE="$PROPOSAL_DIR/${PROPOSAL_ID}.md"
if [ -f "$TEMPLATE" ]; then
cp "$TEMPLATE" "$PROPOSAL_FILE"
# Replace placeholder proposal ID
sed -i "s/PROPOSAL-YYYY-MMDD-NNN/$PROPOSAL_ID/g" "$PROPOSAL_FILE"
sed -i "s/YYYY-MM-DD/$(date +%Y-%m-%d)/g" "$PROPOSAL_FILE"
# Add system if provided
if [ -n "$SYSTEM" ]; then
sed -i "s/\[DBIS | ICCC | SMOM\/SMOA\]/$SYSTEM/g" "$PROPOSAL_FILE"
fi
echo "Created proposal file: $PROPOSAL_FILE"
echo ""
echo "Next steps:"
echo "1. Edit the proposal file with your details"
echo "2. Complete all required sections"
echo "3. Complete compliance checklist"
echo "4. Submit to Tier-1 systems"
else
echo "Warning: Template not found at $TEMPLATE"
echo "Proposal ID generated: $PROPOSAL_ID"
echo "Create proposal file manually using the template"
fi