|
| 1 | +# CodeConverter Repository Summary |
| 2 | + |
| 3 | +## Agent instructions |
| 4 | + |
| 5 | +For any bugfix or feature request: |
| 6 | +* First: Think carefully about the root cause of the issue, and how it would ideally work for minimal maintenance. Contributing.md has more hints on making good tradeoffs, but always generalise a fix rather than hardcode details of a particular case. |
| 7 | +* Use strict TDD. |
| 8 | +* The refactor stage should only be what's essential to the task. |
| 9 | +* Take inspiration from the current tests and shape of code. |
| 10 | +* Once the task is green and complete, make appropriate further refactors to improve code quality and modularity. |
| 11 | + |
| 12 | +## Purpose |
| 13 | +This repository contains a code conversion tool that translates between Visual Basic .NET (VB.NET) and C#. It provides: |
| 14 | +- Command line conversion tools |
| 15 | +- Visual Studio extension (VSIX) |
| 16 | +- Web interface for code conversion |
| 17 | + |
| 18 | +## General Setup |
| 19 | +- Primary solution file: `CodeConverter.slnx` |
| 20 | +- Primarily targets .NET Core |
| 21 | +- Uses GitHub Actions for CI which show dependencies required for build and test (.github/workflows/dotnet.yml) |
| 22 | +- Contains extensive characterization test suite in `Tests/` directory |
| 23 | + |
| 24 | +## Repository Structure |
| 25 | +- `CodeConverter/`: Core conversion logic |
| 26 | +- `CodeConv/`: CLI tool for conversion |
| 27 | +- `Tests/`: Comprehensive test suite |
| 28 | +- `Web/`: Web interface components |
| 29 | +- `Vsix/`: Visual Studio extension |
| 30 | +- `.github/workflows/`: CI/CD pipelines |
| 31 | + |
| 32 | +## CI/CD & Technologies |
| 33 | +- GitHub Actions workflow (`dotnet.yml`) runs: |
| 34 | + - Build and test on Windows/Linux |
| 35 | + - Code analysis |
| 36 | + - Test coverage reporting |
| 37 | +- Primary technologies: |
| 38 | + - .NET Core |
| 39 | + - Roslyn compiler |
| 40 | + - Visual Studio SDK (for VSIX) |
0 commit comments