Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (83 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

117 lines (83 loc) · 3.46 KB

Contributing to TechInterviewMaster

Thank you for your interest in contributing! 🚀 Your help makes this project better for everyone. Whether you’re fixing a typo, adding a new question, or suggesting a feature, your contribution is welcome.

📋 How to Contribute

  1. Fork the repository

  2. Clone your fork

    git clone https://github.com/iamAntimPal/TechInterviewMaster.git

  3. Create a new branch

    git checkout -b feature/your-feature-name

  4. Make your changes

  5. Commit your changes

    git commit -m "Add: your message here"

  6. Push to your fork

    git push origin feature/your-feature-name

  7. Open a Pull Request

    • Go to the original repo and click "New Pull Request".

📝 What Can You Contribute?

  • New interview questions (Python, Git, SQL, JavaScript, Java, etc.)
  • Solutions and explanations
  • Improvements to documentation
  • Bug fixes
  • New features or suggestions

💡 Tips for a Great Contribution

  • Keep your pull requests focused and descriptive.
  • Follow the existing file and folder structure.
  • Add comments to your code where helpful.
  • Proofread your additions for clarity and accuracy.
  • Be respectful and constructive in discussions.

📚 Resources

🤝 Code of Conduct

Please read our Code of Conduct to keep our community welcoming and inclusive.

Python Contribution Guidelines

File Structure for Python Contributions

Interview/
└── Python/
    ├── PDF Files/
    │   └── [PDF resources, e.g., guides, question banks]
    ├── Solutions/
    │   ├── 140+ Basic Python Programs/
    │   │   ├── 140+ Basic Python Programs.ipynb
    │   │   └── Program [number]/
    │   ├── Program/
    │   └── Top 100+ Advanced Python Questions/
    └── [Other topic folders as needed]

Rules for Python Contributions

  1. File Placement:

    • Add new Python questions to the appropriate folder (e.g., Solutions/140+ Basic Python Programs/Program [number]/).
    • Place solutions as Jupyter notebooks (.ipynb) or Python scripts (.py) in the relevant folder.
    • Add new resources (e.g., PDFs, guides) to the PDF Files/ folder.

  2. File Naming:

    • Use clear and descriptive names for files and folders.
    • Follow the existing naming conventions in the repository.

  3. Code Style:

    • Adhere to PEP8 guidelines for Python code.
    • Add comments and explanations to your code for clarity.

  4. Documentation:

    • Update or create a README.md in the folder if you add a new topic or section.

  5. Respect Existing Content:

    • Do not overwrite or delete existing content without prior discussion.

  6. Testing:

    • Ensure your code is tested and works as expected before submitting.

  7. Pull Request Requirements:

    • Clearly describe your changes in the pull request.
    • Reference the issue number if applicable.

By following these guidelines, you help maintain the quality and organization of the repository. Thank you for contributing!

🙋 Need Help?

If you have questions, open an issue or start a discussion. We’re here to help!

Welcome Animation
Happy contributing! 🌟