CONTRIBUTING.md

🌟 Contributing to Awesome-Java

"Great code is not written; it is rewritten. Join us in making Awesome-Java even better!"

We appreciate your interest in contributing to Awesome-Java! This repository aims to be a comprehensive collection of Java libraries and tools. Here’s how you can help us improve:

📚 Table of Contents

• Code of Conduct
• Using the Issue Tracker
• How to Contribute
  • Reporting Issues
  • Submitting New Libraries
  • Submitting Enhancements
  • Pull Requests
• Community Guidelines
• Style Guide
• Testing Your Changes
• Getting Help
• License

📝 Code of Conduct

Please read our Code of Conduct to ensure a positive and inclusive environment.

🛠️ Using the Issue Tracker

Use the issue tracker for:

• Reporting bugs
• Suggesting new libraries
• Proposing enhancements

Please keep discussions on topic and respect the community.

🚀 How to Contribute

🐞 Reporting Issues

Found a bug or have a suggestion? Open an issue with clear details about the problem or enhancement.

📚 Submitting New Libraries

1. Create an Issue: Propose the new library or tool.
2. Fork the Repository: Create a personal copy on GitHub.
3. Add Your Library: Include a brief description and link.
4. Submit a Pull Request: Open a PR to review and merge your changes.

✨ Submitting Enhancements

1. Create an Issue: Describe the enhancement.
2. Fork and Modify: Make changes in your fork.
3. Open a Pull Request: Explain your changes and submit for review.

📥 Pull Requests

When submitting a PR:

• Base Branch: Use the latest master branch.
• Be Clear: Provide a concise explanation of the changes.
• Review: Be open to feedback and suggestions.

👥 Community Guidelines

• Respect: Engage respectfully with all contributors.
• Quality: Ensure any additions are high-quality and well-documented.
• Focus: Keep contributions relevant to Java libraries and tools.

📏 Style Guide

• Consistency: Follow existing styles and conventions.
• Documentation: Update documentation to reflect changes.
• Commit Messages: Write clear and descriptive commit messages.

🧪 Testing Your Changes

Ensure all changes pass existing tests and write new tests for added functionalities.

💬 Getting Help

For help or questions, open an issue or join discussions in the community.

📜 License

By contributing, you agree that your contributions are licensed under the same license as the project. See the LICENSE file for details.

---

Thank you for helping improve Awesome-Java! Let’s build something great together. 🎉