Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 2.18 KB
Raw

Contributing to This Repository 🤝

Thanks for considering contributing to this project! 🌟

How to Contribute ✨

Before making a contribution, please ensure the following:

  1. Descriptive Pull Request 📑:

    • When submitting a pull request (PR), provide a detailed explanation of the changes made.
    • Specifically, mention which files and folders have been added or modified.
    • This will help in understanding the contributions and integrating them smoothly into the project.

  2. Ensure Proper Formatting 🖋️:

    • Make sure your code follows the project’s coding standards and guidelines.
    • Add appropriate comments and documentation where necessary.

  3. File Naming Conventions 📂:

    • Exam Questions: If you are adding previous year questions, ensure the file name follows this format:

      Exam_name_Year_Branch.pdf

      Examples:

      • Class_Test_1_AI_2023.pdf
      • Annual_Examination_AI_2023.pdf
      • Class_Test_1_DS_2023.pdf

    • Syllabi: For syllabi, use this format:

      Semester_Branch_Year_Syllabus.pdf

      Examples:

      • 5th_Semester_AI_2023_Syllabus.pdf
      • 2nd_Semester_DS_2023_Syllabus.pdf

  4. Relevant Notes 📝:

    • If you are adding notes related to the subject, ensure that the file names do not conflict with existing ones.
    • Use the format name_branch_year for naming notes files.
    • Make sure that the notes are placed in the appropriate folder that aligns with the content.
    • If you are unsure about the appropriate folder or have any issues, feel free to post in the Discussions or Issues section to ask for guidance.

Review the Pull Request Template 📜

Before creating a pull request, please make sure to visit the pull request template to understand the required information and structure. This will help ensure that your pull request is complete and easy to review.

Thank you for your contributions! 🎉