Use the table of contents icon 
on the top left corner of this document to get to a specific section of this guide quickly.
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on IIITH-Resources Github Repository & IIITH-Resources Web-Page ✨.
Please Read our Code of Conduct to keep our community approachable and respectable.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
- Use Good First Issue Tag in Issues section.
Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
- Find an issue that you are interested in addressing or a feature that you would like to add.
- Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under <your username>/iiith-resources.github.io.
- Clone the repository to your local machine using git clone https://github.com/<your_username>/iiith-resources.github.io.git.
- Create a new branch for your fix using git checkout -b branch-name-here.
- Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
- Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
- Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
- Push the changes to the remote repository using git push origin branch-name-here.
- Submit a pull request to the upstream repository.
- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
- Wait for the pull request to be reviewed by a maintainer.
- Make changes to the pull request if the reviewing maintainer recommends them.
- Celebrate your success after your pull request is merged!
By contributing, you agree that your contributions will be licensed under the same License
- Please make sure that you are making changes on the Latest version of the Github Repo Code.
- Please be respectful to the Contributors guidelines & Reviews.
- Don't name the files with abbreviations and rather will full names.
- Place the files (Resources), that you want to contribute in correct folders.
- Please check and don't remove some of the important elements of HTML files & once check that before commiting by checking the differences in your file and the existing file(if any).
- Please make sure that no Temporary Files are uploaded.
- Please firstly confirm that no one else had earlier same kind of issue, which have been solved or listed.
- Don't upload or link to any Copyrighted Material.
- If you see any copyrighted material, please inform us ASAP by creating a new issue.
- Please be specific in writing the Title.
- Add Correct Labels, so as to make everyoen understand your issue effectively.
- Make sure that if you are making any code enhancements/additions, you have checked them on your local machine and are confirmed that they are not broken in any way.
- Please attach screenshots, if applicable.
- Please write to the point, crisp description for your issue.
- If you want to become an official Contributor into the Project, please use Contributor Request Tag, along with listing WHY you want to become an official Contributor into this Project and what excites you about this project. Also, mention your Email ID with it.
Contact any of the contributor via their GitHub ID, or create an issue with HELP in Title, and we would be there for you at all times.