Contributing

Contributing to TornadoScript

We welcome contributions to TornadoScript! This guide will help you get started.

Getting Started

1. Fork the repository
2. Clone your fork locally
3. Set up the development environment
4. Create a new branch for your feature

Development Setup

Prerequisites

• Visual Studio 2019 or later
• .NET Framework 4.8
• GTA V installed for testing

Building the Project

1. Open the solution in Visual Studio
2. Restore NuGet packages
3. Build the solution
4. Copy the built files to your GTA V directory for testing

Making Changes

1. Create a descriptive branch name (e.g., feature/improved-tornado-physics)
2. Make your changes
3. Add appropriate comments and documentation
4. Test thoroughly
5. Commit with clear, descriptive messages

Pull Request Process

1. Update documentation if needed
2. Ensure all tests pass
3. Push to your fork
4. Create a Pull Request with:
   • Clear description of changes
   • Screenshots/videos if applicable
   • Reference to any related issues

Code Style Guidelines

• Follow C# naming conventions
• Use meaningful variable and function names
• Comment complex logic
• Keep methods focused and concise
• Add XML documentation for public APIs

Testing

• Test your changes in various scenarios
• Verify compatibility with different GTA V versions
• Check performance impact
• Test with other popular mods

Need Help?

• Check existing issues and discussions
• Join our Discord community
• Read the documentation
• Ask questions in the appropriate channels