Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

73 lines (48 loc) · 2.86 KB
Raw

Contributing to BVRITHDrive

Thank you for considering contributing to BVRITHDrive! This repository is a collaborative effort aimed at making academic resources accessible to all BVRIT Hyderabad students. Your contributions are valuable and help build a richer, more comprehensive resource for everyone.

Note: If you’re uploading material provided by the faculty, please confirm with them before adding it to the repository. If it’s your own content, feel free to upload it directly. This ensures that we respect intellectual property and maintain the integrity of the repository.

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account. This creates a copy of the repo that you can freely edit without affecting the original.

2. Clone the Repository

Next, clone your forked repository to your local machine so you can start making changes.

git clone https://github.com/your-username/BVRITHDrive.git

3. Organize Your Contribution

Please organize your files according to the repository structure. Each subject or resource type should go into its respective folder. If you’re adding something new, feel free to create a new folder, but keep the naming clear and straightforward.

Example:

BVRITHStudy/
│
├── Bits/
├── Imp Questions/
├── Mid Papers/
├── Notes/
├── PYQs/
└── R22_Syllabus.pdf

4. Add and Commit Your Changes

Once you've added your files, commit your changes with a clear and descriptive commit message.

git add .
git commit -m "Added [description of your contribution]"

5. Push to Your Fork

Push your changes to your forked repository on GitHub.

git push

6. Create a Pull Request

Finally, go to your fork on GitHub and create a pull request (PR) to the main BVRITHDrive repository. Describe what you've added or changed in the PR description so it's clear to everyone what your contribution is about.

Contribution Guidelines

To ensure that BVRITHDrive remains a valuable resource, please keep the following guidelines in mind:

  • Respect the Structure: Follow the existing structure of the repository to keep things organized.
  • Clear Naming: Use clear and descriptive names for your files and folders.
  • Original Content: Ensure that any notes, questions, or other materials you contribute are your own work or properly credited. Avoid sharing copyrighted material without permission.
  • Quality Over Quantity: Focus on providing accurate, helpful resources rather than just uploading files for the sake of it.
  • Positive Community: Maintain a respectful and supportive tone in all communications.

Code of Conduct

By contributing to this repository, you agree to adhere to the Code of Conduct. This ensures a welcoming and inclusive environment for all contributors.