Skip to main content

FELgt Contribution - Quick Start Checklist

🚀 Quick Reference​

Initial Setup (One Time)​

# 1. Fork on GitHub (click Fork button)
# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/FELgt.git
cd FELgt

# 3. Add upstream remote
git remote add upstream https://github.com/krudos/FELgt.git

# 4. Verify
git remote -v

For Each Feature/PR​

# 1. Update your fork
git checkout main
git pull upstream main
git push origin main

# 2. Create feature branch
git checkout -b feature/typescript-generator

# 3. Make your changes
# ... edit files ...

# 4. Test your changes
# ... run tests, verify output ...

# 5. Commit
git add .
git commit -m "feat: Add TypeScript generator

- Implement TypeScriptGenerator class
- Add type mapping
- Update documentation"

# 6. Push to your fork
git push origin feature/typescript-generator

# 7. Create PR on GitHub
# - Go to your fork
# - Click "Compare & pull request"
# - Fill out PR form
# - Submit

📝 PR Template​

Title:

feat: Add TypeScript code generator

Description:

## Description
Adds TypeScript code generation support, similar to existing C# generator.

## Changes
- ✅ Implemented TypeScriptGenerator class
- ✅ Added TypeScript type mapping
- ✅ Support for namespaces
- ✅ Added tests
- ✅ Updated README

## Testing
- [x] Generated TypeScript from XSD
- [x] Verified TypeScript compiles
- [x] Tested with sample schemas

## Example Output
\`\`\`typescript
export interface DatosGenerales {
  Tipo: 'FACT' | 'NCRE' | 'NDEB';
  FechaHoraEmision: string;
}
\`\`\`

🔧 Common Commands​

# Check status
git status

# See what branch you're on
git branch

# Switch branches
git checkout branch-name

# See commit history
git log --oneline

# See changes
git diff

# Undo uncommitted changes
git checkout -- file-name

# Update from upstream
git fetch upstream
git merge upstream/main

✅ Before Submitting PR​

  • Code works and is tested
  • Follows project style
  • Documentation updated
  • Commit messages are clear
  • Branch is up to date
  • PR description is complete

See full guide: felgt-contribution-guide.md