Contributing Guidelines

About This Work

Microservices Recipes: The Architect’s Field Guide is the original work of Viquar Khan. Version 2.1 is 23 chapters. All of them are in this repository.

Contribution Scope

While this is primarily an author-driven publication, I welcome specific types of community input to enhance the value for all readers:

✅ Welcome Contributions

📋 Issue Reports

  • Bug reports - Found errors, typos, or technical inaccuracies
  • Broken links - Links that no longer work or redirect incorrectly
  • Formatting issues - Display problems or rendering errors
  • Technical corrections - Factual errors in code examples or explanations

📚 Real-World Case Studies

  • Implementation experiences using patterns from this book
  • Production lessons learned applying Adaptive Granularity Governance: The Khan Microservice Pattern
  • Success stories and transformation journeys
  • Anonymous case studies from your organization (with proper anonymization)

💡 Future Edition Suggestions

  • Topics you’d like to see in future versions
  • Additional patterns that would be valuable
  • Industry trends that should be covered
  • Specific use cases that need more coverage

How to Contribute

🐛 Reporting Issues

  1. Check existing issues to avoid duplicates
  2. Use clear, descriptive titles for your issue
  3. Provide specific details about the problem
  4. Include screenshots if relevant for formatting issues

📖 Sharing Case Studies

  1. Email the author with your case study proposal
  2. Ensure proper anonymization of sensitive information
  3. Focus on lessons learned and practical insights
  4. Highlight specific patterns used from the book

💭 Suggesting Future Content

  1. Open a GitHub issue with the “enhancement” label
  2. Describe the specific topic or pattern you’d like covered
  3. Explain the business value and use cases
  4. Provide context about why it’s important

Author’s Review Process

All contributions are subject to author review and approval. The author reserves the right to:

  • Accept, modify, or decline any contribution
  • Maintain editorial control over all content
  • Ensure consistency with the book’s methodology and style
  • Respect dual licensing (MIT for code; CC BY-NC-ND 4.0 for prose and figures; see LICENSING.md)
  • Attribute and cite Adaptive Granularity Governance: The Khan Microservice Pattern when you reference it

Recognition

Accepted contributions will be acknowledged in the book’s acknowledgments section, respecting contributor preferences for attribution.

Contact Information

For contribution inquiries:

By contributing, you acknowledge that:

  • This is the original work of Viquar Khan
  • Code contributions become part of the work under MIT
  • Prose and figure contributions become part of the work under CC BY-NC-ND 4.0
  • The author retains full editorial control
  • Original methodologies remain the intellectual property of Viquar Khan. Cite them. No trademark is claimed.

Corrections and anonymized case notes help. Keep the 2019-to-present record in CHANGELOG.md and VERSION-HISTORY.md when you propose a change.