Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (81 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

122 lines (81 loc) · 2.37 KB
Raw

Contributing to JavaVerse - Quick Notes

Thank you for your interest in contributing to JavaVerse - Quick Notes.

We welcome contributions from beginners, students, and experienced developers. Whether you want to improve existing notes, add new chapters, fix formatting issues, or organize content better, every contribution is valuable.

How to Contribute

1. Fork the Repository

Click the Fork button at the top-right corner of this repository to create your own copy.

2. Clone the Repository

git clone https://github.com/your-username/JavaVerse-QuickNotes.git
cd JavaVerse-QuickNotes

3. Create a New Branch

git checkout -b feature/your-feature-name

Example:

git checkout -b feature/add-java-collections-notes

4. Add Your Contribution

You can contribute by:

  • Adding new Java notes in PDF format
  • Improving existing notes
  • Fixing formatting or spelling mistakes
  • Organizing repository structure
  • Adding interview preparation material

Please ensure:

  • Notes are clear and easy to understand
  • File names are meaningful
  • Content is properly formatted
  • Duplicate topics are avoided

Example structure:

JavaVerse-QuickNotes/
│── Chapter-1/
│   ├── Introduction-to-Java.pdf
│
│── Chapter-2/
│   ├── Java-Basics.pdf

5. Commit Your Changes

git add .
git commit -m "Added Java Collections notes"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Open a Pull Request

  • Go to the original repository
  • Click New Pull Request
  • Compare your branch with the main branch
  • Submit the Pull Request

Contribution Rules

  • Maintain the existing folder structure
  • Upload notes in PDF format
  • Use meaningful file names
  • Keep content clean and beginner-friendly
  • Avoid duplicate chapters or topics
  • Ensure notes are readable and properly formatted

Recognition

All contributors will be recognized in the repository contributors section once their Pull Request is merged.

Need Help?

If you have questions or need help:

  • Open an Issue
  • Start a discussion
  • Reach out through the repository discussions section

Thank You

Your contributions help make Java learning more accessible and organized for everyone.