instructions.md

ado-analytics — Developer & Contributor Instructions

Project Structure

• python/ — Python scripts and requirements
• csharp/ — C# scripts
• terraform/ — Terraform infrastructure as code
• main.odata — Example OData query
• .env.example — Sample environment variables

Setup

1. Copy .env.example to .env and fill in your values.
2. Install dependencies for the language you want to use (see README).
3. Follow the Quick Start in the README for each language.

Adding Features

• Place new scripts in the appropriate language folder.
• Use environment variables for secrets/configuration.
• Add docstrings and comments to your code.
• Add tests if possible (see below).

Testing

• Python: Add test files in python/ and use pytest.
• C#: Add a test project or use inline test code.
• Terraform: Use terraform plan to validate changes.

Best Practices

• Use logging instead of print for production code.
• Handle errors with context.
• Keep secrets out of source control.
• Update documentation when you add features.

Troubleshooting

• Ensure your .env is filled out and present in the working directory.
• Check dependencies are installed for your language.
• See error messages for missing environment variables or authentication issues.

Contributing

• Fork, branch, and submit PRs for new features or fixes.
• Keep code style consistent with existing code.
• Add or update documentation as needed.