Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

56 lines (44 loc) · 1.83 KB

Contributing to Java OOPs Concepts Repository

Thank you for your interest in contributing to the Java-OOPs-Concepts-Repo! We welcome all contributions, whether it's fixing a bug, improving documentation, or adding new features.

How to Contribute

1. Fork the Repository

  • Click the Fork button on the top right of the repository page to create your copy.
  • Clone your fork to your local machine: 
    git clone https://github.com/your-username/Java-OOPs-Concepts-Repo.git
cd Java-OOPs-Concepts-Repo

2. Create a New Branch

  • Always work in a new branch before making changes: 
    git checkout -b feature-branch-name

3. Make Your Changes

  • Add or modify Java examples in the src/ directory.
  • Update the corresponding Explanation.md file for clarity.
  • If applicable, update UML diagrams in the diagrams/ folder.
  • Ensure your code follows clean coding principles and Java best practices.

4. Commit Your Changes

  • Write clear and descriptive commit messages: 
    git add .
git commit -m "Added InheritanceExample.java with explanation"

5. Push and Submit a Pull Request

  • Push your changes to your fork: 
    git push origin feature-branch-name
  • Go to the original repository and click New Pull Request.
  • Provide a clear title and description of your changes.

Contribution Guidelines

✔ Follow proper coding conventions. ✔ Keep explanations clear and concise. ✔ If modifying existing code, ensure backward compatibility. ✔ Always test your code before submitting. ✔ Contributions should be relevant to OOP concepts in Java.

Reporting Issues

If you find a bug or have a suggestion, open an issue with a detailed explanation.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Happy coding! 🚀