Skip to content

Latest commit

 

History

History
70 lines (53 loc) · 2.06 KB

File metadata and controls

70 lines (53 loc) · 2.06 KB

Contributing to Java Spring Fundamentals Guide

Thank you for your interest in contributing to this educational resource! 🎉

🤝 How to Contribute

Reporting Issues

  • Found an error in the code examples? Open an issue!
  • Have suggestions for additional topics? We'd love to hear them!
  • Spotted typos or unclear explanations? Please let us know!

Suggesting Improvements

  • Content Enhancement: Suggest additional examples or better explanations
  • New Modules: Propose new topics that would benefit Spring developers
  • Code Examples: Submit improved or additional code samples
  • Exercise Ideas: Contribute practice problems and solutions

Submitting Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/improvement-name)
  3. Make your changes
  4. Test any code examples
  5. Commit with clear messages
  6. Push to your fork
  7. Open a Pull Request

📝 Guidelines

Content Standards

  • Keep explanations clear and beginner-friendly
  • Include practical examples
  • Explain the Spring Framework relevance
  • Follow the existing module structure

Code Examples

  • Use modern Java features (Java 11+)
  • Include comments for complex logic
  • Ensure code compiles and runs
  • Follow Java naming conventions

Documentation

  • Use consistent Markdown formatting
  • Include proper code syntax highlighting
  • Keep line lengths reasonable
  • Use clear headings and structure

🎯 Areas We Need Help With

  • Additional code examples for complex concepts
  • Real-world Spring integration examples
  • Performance optimization tips
  • Common interview questions and answers
  • Video tutorial links
  • Translation to other languages

📋 Before Contributing

Please:

  • Read through existing content to avoid duplication
  • Check open issues and PRs
  • Ensure your contribution adds value
  • Test any code examples

🙏 Recognition

All contributors will be acknowledged in our README. Thank you for helping make Java education better!


This guide was initially created with AI assistance and is maintained by the community.