CONTRIBUTING.md

Contributing to Zig University

Thank you for your interest in contributing to Zig University! This document provides guidelines and instructions for contributing to this educational project.

Ways to Contribute

There are many ways you can contribute to Zig University:

1. Add new examples: Create new examples demonstrating Zig features or use cases
2. Improve existing examples: Enhance code, add comments, or fix bugs in existing examples
3. Documentation: Improve explanations, add notes, or create tutorials
4. Testing: Ensure examples work across different Zig versions
5. Feedback: Report issues or suggest improvements

Guidelines for Examples

When contributing code examples, please follow these guidelines:

1. Self-contained: Each example should be self-contained and demonstrate a specific concept
2. Well-commented: Include detailed comments explaining what the code does
3. Error handling: Demonstrate proper error handling
4. Naming convention: Follow Zig's naming conventions
5. Tested: Ensure your example compiles and runs with the latest Zig release

Code Style

Follow the Zig style guide for all code contributions:

• Use 4 spaces for indentation (not tabs)
• Keep lines under 100 characters when possible
• Use camelCase for function and variable names
• Use PascalCase for types
• Use snake_case for file names

Submitting Contributions

1. Fork the repository
2. Create a new branch for your feature or fix
3. Make your changes
4. Test your changes with the latest Zig version
5. Submit a pull request with a clear description of your changes

Review Process

All contributions will be reviewed for:

1. Code quality and style
2. Educational value
3. Accuracy and correctness
4. Documentation quality

Getting Help

If you have questions about contributing or need help with your contribution, please open an issue on the repository with your question.

Thank you for helping to improve Zig University and spreading knowledge about the Zig programming language!