Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
177 lines (134 loc) · 5.39 KB

CONTRIBUTING.md

File metadata and controls

177 lines (134 loc) · 5.39 KB

Contributing

Thank you for your interest in contributing to the Java in 50 Days learning repository! This document provides guidelines and steps for contributing to make this resource even better for learners.

🤝 How to Contribute

We welcome contributions from everyone, whether you're a beginner or an experienced Java developer. Here are the main ways you can contribute:

📚 Content Improvements

  • Add more examples to existing days
  • Improve explanations in README files
  • Fix typos or errors in code or documentation
  • Add exercises to reinforce learning
  • Create additional practice problems

🆕 New Content

  • Add new topics that would benefit learners
  • Create additional days beyond the current 50
  • Add real-world project examples
  • Create cheat sheets or quick reference guides

🐛 Bug Fixes

  • Fix compilation errors in Java files
  • Correct logical errors in examples
  • Update outdated information
  • Fix broken links in documentation

📋 Contribution Guidelines

Code Style

  • Follow Java naming conventions (camelCase for variables/methods, PascalCase for classes)
  • Use meaningful variable and method names
  • Add comments to explain complex logic
  • Keep examples simple and educational
  • Ensure all code compiles and runs without errors

Documentation Style

  • Write clear, concise explanations
  • Use markdown formatting consistently
  • Include code examples where appropriate
  • Add exercises that reinforce the day's concepts
  • Keep explanations beginner-friendly

File Organization

  • Each day should have a clear topic focus
  • Include both README.md and Java example files
  • Use descriptive file names
  • Maintain consistent folder structure

🚀 How to Submit Contributions

Step 1: Fork the Repository

  1. Click the "Fork" button on the GitHub repository page
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/Zemerik/Java.git
cd Java

Step 2: Create a Branch

Create a new branch for your contribution:

git checkout -b feature/your-contribution-name

Step 3: Make Your Changes

  • Edit existing files or create new ones
  • Test your changes to ensure they work correctly
  • Follow the coding and documentation guidelines above

Step 4: Commit Your Changes

Commit your changes with a descriptive message:

git add .
git commit -m "Add: [Brief description of your contribution]"

Step 5: Push and Create a Pull Request

  1. Push your changes to your fork:

    git push origin feature/your-contribution-name

  2. Go to your fork on GitHub and click "New Pull Request"

  3. Fill out the pull request template with:

    • Title: Brief description of your contribution
    • Description: Detailed explanation of what you changed and why
    • Type of contribution: Content improvement, bug fix, new feature, etc.

📝 Pull Request Template

When creating a pull request, please use this template:

## Description
Brief description of what this PR accomplishes.

## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Content improvement (enhancing existing material)
- [ ] Documentation update
- [ ] Code refactoring

## What was changed?
- [List specific changes made]

## Testing
- [ ] Code compiles without errors
- [ ] Examples run successfully
- [ ] Documentation is clear and accurate

## Additional Notes
Any additional information or context for reviewers.

🎯 Specific Contribution Areas

For Beginners

  • Test existing examples and report any issues
  • Suggest improvements to explanations
  • Add comments to clarify complex code
  • Create simple exercises for practice

For Intermediate Developers

  • Add more advanced examples
  • Create additional exercises
  • Improve code efficiency
  • Add best practices

For Experienced Developers

  • Add new topics (e.g., advanced design patterns, microservices)
  • Create real-world project examples
  • Add performance optimization examples
  • Contribute to the capstone project

📋 Review Process

  1. Initial Review: We'll review your pull request within 48 hours
  2. Feedback: We may request changes or improvements
  3. Approval: Once approved, your contribution will be merged
  4. Credit: Your name will be added to the contributors list

🏷️ Issue Reporting

If you find a bug or have a suggestion, please:

  1. Search existing issues to avoid duplicates
  2. Create a new issue with a clear title and description
  3. Include details about the problem or suggestion
  4. Add labels if applicable (bug, enhancement, documentation, etc.)

📞 Getting Help

If you need help with contributing:

  1. Check existing issues and pull requests
  2. Ask questions in the issues section
  3. Join discussions about the project
  4. Read the documentation thoroughly

🎉 Recognition

Contributors will be recognized in:

  • The project's README.md file
  • Release notes for significant contributions
  • Special mentions for major improvements

📄 License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

Thank you for helping make Java learning better for everyone! 🚀

Your contributions help thousands of learners master Java programming.