AI Development Workspace Template

This repo is currently being developed - as new projects that are being worked on are completed, any lessons, tools, etc learned will make their way to this repo. This repo uses other related public repos to create some of these files and comments. Where other people's work has been referenced, recognition of the author is stated where applicable.

Current repo's that have been reviewed and referenced -

Marc Christenfeldt - marcbln - https://github.com/marcbln?tab=repositories

This repo is being developed to become a comprehensive development workspace optimized for AI-assisted programming with integrated quality tools, testing frameworks, and automation.

🌟 Features

🚀 Multi-Language Support

• Python 3.11+ with advanced typing and modern practices
• C/C++ with C11/C++17 standards and strict quality checks
• Java 11+ with Maven/Gradle integration
• C# .NET 6+ with modern async patterns

📊 Quality Assurance

• Comprehensive Linting: Ruff, ESLint, Checkstyle, clang-tidy
• Type Safety: MyPy, TypeScript, nullable reference types
• Security Scanning: Bandit, SonarQube, Trivy
• Code Coverage: pytest-cov, JaCoCo, coverlet
• Static Analysis: SonarQube integration with cognitive complexity limits

🤖 AI Development Optimized

• GitHub Copilot integration with workspace-specific instructions
• Pre-configured prompts and context for AI tools
• Template-based project generation
• Quality-first approach to AI-generated code
• Automated code review patterns

🔧 Developer Experience

• VS Code workspace with comprehensive language support
• Automated setup scripts for new projects
• Pre-commit hooks for quality enforcement
• GitHub Actions CI/CD with multi-platform testing
• Docker support for consistent environments

🚀 Quick Start

1. 📎 Clone the Template

# Use this template to create a new repository
gh repo create my-ai-project --template yourusername/ai-development-workspace
cd my-ai-project

# Or clone directly
git clone https://github.com/yourusername/ai-development-workspace.git
cd ai-development-workspace

2. 💻 Open in VS Code

code AI-Development-Workspace.code-workspace

3. ⚙️ Setup Environment

# Python environment
python -m venv .venv
.venv\Scripts\Activate.ps1  # Windows
source .venv/bin/activate   # Linux/macOS
pip install -r requirements.txt

# Install pre-commit hooks
pre-commit install

# Verify setup
python scripts/setup_project.py --list-templates

4. 🎆 Create Your First Project

# Create a new Python AI project
python scripts/setup_project.py my-ai-app python
cd my-ai-app
code .

📚 Project Structure

ai-development-workspace/
├── 💼 .vscode/                    # VS Code configuration
│   ├── settings.json              # Multi-language settings
│   ├── tasks.json                 # Build and test tasks
│   └── extensions.json            # Recommended extensions
├── 🔄 .github/                    # GitHub configuration
│   ├── workflows/ci.yml           # CI/CD pipeline
│   ├── ISSUE_TEMPLATE/            # Issue templates
│   ├── pull_request_template.md   # PR template
│   └── copilot-instructions.md    # AI instructions
├── 📦 templates/                  # Project templates
│   ├── python/                    # Python project template
│   ├── c-cpp/                     # C/C++ project template
│   ├── java/                      # Java project template
│   └── csharp/                    # C# project template
├── 🛠️ scripts/                    # Utility scripts
│   └── setup_project.py           # Project generator
├── 📋 pyproject.toml              # Python quality config
├── 🔍 sonar-project.properties   # SonarQube config
├── ⚙️ .pre-commit-config.yaml     # Pre-commit hooks
├── 📦 requirements.txt            # Python dependencies
└── 📜 README.md                   # This file

🎯 Supported Languages & Features

Language	🚀 Template	⚙️ Build System	📊 Testing	🔍 Linting	🔒 Security
Python	✅	pip/poetry	pytest	ruff, mypy	bandit
C/C++	✅	Make/CMake	Google Test	clang-tidy	cppcheck
Java	✅	Maven/Gradle	JUnit 5	Checkstyle	SpotBugs
C#	✅	.NET CLI	xUnit	.NET analyzers	Security analyzers

🤖 AI Development Features

💡 GitHub Copilot Integration

• Workspace-specific instructions in .github/copilot-instructions.md
• Context-aware suggestions for each language
• Quality-first prompting patterns
• Template-aware code generation

🎯 Quality-Driven AI Assistance

# Example: AI-generated code with quality enforcement
def process_data(data: List[Dict[str, Any]]) -> ProcessedData:
    """Process input data with comprehensive error handling.
    
    Args:
        data: List of data dictionaries to process
        
    Returns:
        ProcessedData: Validated and transformed data
        
    Raises:
        ValidationError: If data format is invalid
    """
    if not data:
        raise ValueError("Input data cannot be empty")
    
    try:
        return ProcessedData.from_dict_list(data)
    except Exception as e:
        logger.error(f"Data processing failed: {e}")
        raise ProcessingError(f"Failed to process data: {e}") from e

📈 AI Code Quality Metrics

• Cognitive Complexity: ≤15 per function
• Type Coverage: 100% for new code
• Documentation: All public APIs
• Test Coverage: ≥80%
• Security: Zero high/critical issues

🛠️ Usage Guide

🔄 Creating New Projects

# List available templates
python scripts/setup_project.py --list-templates

# Create Python AI project
python scripts/setup_project.py my-ml-app python

# Create C++ systems project
python scripts/setup_project.py my-sys-app c-cpp

# Create Java web service
python scripts/setup_project.py my-api-app java

# Create C# desktop app
python scripts/setup_project.py my-gui-app csharp

📊 Running Quality Checks

# Python projects
ruff check .
ruff format .
mypy .
pytest --cov

# C/C++ projects
make analyze
make test

# Java projects
mvn checkstyle:check
mvn test

# C# projects
dotnet format --verify-no-changes
dotnet test

🔒 Security Scanning

# Python security
bandit -r .
safety check

# Multi-language
pre-commit run --all-files
trivy fs .

🔧 Configuration

⚙️ VS Code Settings

The workspace includes comprehensive settings for:

• Multi-language formatting (Ruff, Prettier, clang-format)
• Linting integration (real-time error detection)
• Type checking (MyPy, TypeScript, C# nullable)
• Debugging configuration (Python, C++, Java, C#)
• AI assistance (Copilot, IntelliSense)

🔄 CI/CD Pipeline

Automated workflows include:

• Multi-platform testing (Ubuntu, Windows, macOS)
• Language-specific builds (triggered by file changes)
• Security scanning (Trivy, Bandit, SonarQube)
• Quality gates (coverage, complexity, security)
• Automated deployment (configurable)

🔌 Integration Examples

🔗 SonarQube Setup

# sonar-project.properties (auto-configured)
sonar.projectKey=my-ai-project
sonar.sources=.
sonar.exclusions=**/*test*/**,**/node_modules/**
sonar.python.version=3.11
sonar.cfamily.compile-commands=compile_commands.json

🤖 AI Tool Configuration

// .vscode/settings.json
{
  "github.copilot.enable": {
    "*": true,
    "markdown": true
  },
  "sonarlint.rules": {
    "python:S3776": {
      "level": "on",
      "parameters": { "threshold": "15" }
    }
  }
}

📚 Documentation

• Development Guide - Detailed development workflow
• Language Guides - Language-specific best practices
• AI Integration - AI tool setup and usage
• AI Coding Prompts - Structured AI development prompts (includes marcbln's proven patterns)
• Quality Standards - Code quality requirements
• Security Guidelines - Security best practices

🤝 Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Follow quality standards (pre-commit hooks will help)
4. Add tests for new functionality
5. Update documentation as needed
6. Submit a pull request

See CONTRIBUTING.md for detailed guidelines.

🐞 Troubleshooting

Common Issues

Python Environment Issues

# Reset Python environment
rm -rf .venv
python -m venv .venv
.venv\Scripts\Activate.ps1
pip install -r requirements.txt

Pre-commit Hook Failures

# Fix formatting issues automatically
ruff format .
pre-commit run --all-files

SonarQube Java Issues

# Ensure Java 11+ is installed
java -version
# Set JAVA_HOME if needed
export JAVA_HOME=/path/to/java

📜 Changelog

See CHANGELOG.md for version history and updates.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

💬 Support

• 🐛 Bug Reports: GitHub Issues
• 💫 Feature Requests: GitHub Discussions
• 💬 Community: Discord Server
• 📧 Email: support@yourproject.com

🔗 Related Projects

• AI Code Review Tools
• Development Automation Scripts
• Quality Gate Configurations

---

✨ Built with ❤️ for AI-assisted development

Getting Started • Documentation • Support