Contributing to AZD For Beginners

February 5, 2026 ยท View on GitHub

Thank you for your interest in contributing to the AZD For Beginners course! This document provides guidelines and information for contributors.

How to Contribute

Reporting Issues

If you find bugs, errors, or have suggestions for improvements:

  1. Check Existing Issues: Search existing issues to avoid duplicates
  2. Create a New Issue: Use the appropriate issue template
  3. Provide Details: Include steps to reproduce, expected behavior, and screenshots if applicable

Proposing Changes

  1. Fork the Repository: Create your own fork of the project
  2. Create a Branch: Create a feature branch for your changes
  3. Make Changes: Follow our coding and documentation standards
  4. Test Your Changes: Verify all links work and content renders correctly
  5. Submit a Pull Request: Provide a clear description of your changes

Types of Contributions

We welcome the following types of contributions:

Content Improvements

  • Fix typos, grammar, and formatting issues
  • Improve clarity of existing documentation
  • Update outdated information
  • Add missing explanations or context

New Examples

  • Add real-world deployment scenarios
  • Create new AZD templates for common use cases
  • Provide additional code samples and exercises

Translation Support

  • Help maintain existing translations
  • Improve translation quality
  • Add translations for new content

Bug Reports

  • Report broken links or incorrect code examples
  • Identify documentation inconsistencies
  • Flag accessibility issues

Contribution Guidelines

Documentation Standards

  • Use clear, beginner-friendly language
  • Include learning objectives and outcomes
  • Provide step-by-step instructions with expected outputs
  • Add navigation links to related content
  • Use consistent formatting and markdown style

Code Examples

  • Ensure all code examples are tested and working
  • Include comments explaining key concepts
  • Follow Azure and AZD best practices
  • Provide expected output where applicable

Commit Messages

Use clear, descriptive commit messages:

  • docs: fix typo in installation guide
  • feat: add new container app example
  • fix: correct broken link in chapter 2

Code of Conduct

Please read and follow our Code of Conduct to maintain a welcoming and inclusive community.

Getting Help

License

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make AZD For Beginners a better learning resource for the community!