Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.17 KB

Contributing to Spring Boot Mastery

Thank you for your interest in contributing to Spring Boot Mastery! 🎉

How to Contribute

1. Reporting Issues

  • Use GitHub Issues to report bugs or suggest features
  • Provide clear description and steps to reproduce
  • Include relevant code snippets or error messages

2. Adding New Projects

  • Follow the existing project structure
  • Include comprehensive README for each project
  • Add appropriate annotations and comments
  • Ensure project builds and runs successfully

3. Improving Documentation

  • Fix typos or improve clarity
  • Add more examples or explanations
  • Update outdated information
  • Ensure consistent formatting

4. Code Standards

  • Follow Spring Boot best practices
  • Use meaningful variable and method names
  • Include appropriate comments
  • Write unit tests where applicable

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Questions?

Feel free to open an issue for any questions about contributing!