Welcome to Git Heat! Each week we will be providing you with a small project idea or let’s say a real life problem statement along with an extensive list of resources that'll help you gain the skills required for the project. You will have one week to learn the relevant technologies and solve the problem. At any time during this period, you can submit your code for review by filling the submission form and we will get back to you. Make sure you read and follow the coding instructions. If you have any doubts, you can reach out to us anytime on slack. So what are you waiting for? Jump right in !!!
-
You'll have to use Git & Github for version control. Here are some resources to get you started:
-
Make your github account (if you don’t already have one). Avail github student pack to get amazing student benefits like free services & private repositories. You may use college email-id or semester registration card to avail it. This process generally takes 24 - 48 hours for approval. (Although student pack isn't required for participating in Git Heat, we highly recommend claiming it. After all, it's free!)
On your local machine, prepare the solution in a new folder. Here enable and use git to keep track of your files. Once your solution is prepared do the following:
- Go to your github account and make a new repository.
- Push your code to github. You will be asked to initialize it with readme.md file. Click on it, you will be required to write your full documentation here. You can also make a readme file after the code has been pushed to github. A readme.md file is a MUST. Your readme.md file must contain the following:
- How to run? This is very important as we all use different tools so provide a brief description as to how you ran your code in your pc while preparing the solution.
- Softwares / Tools used while making the project.
- What your project does? Describe each and every feature (more or less) of your project.
- Make sure you make your repository public.
- Once you feel you have fulfilled the basic requirements, fill the submission form. We will review your code and create issues accordingly.
- Make sure you regularly keep an eye on issues and code reviews on commits. After the specified time period, you will be evaluated on the basis of issues closed, project execution, code quality, ideas and many more parameters.
- Keep committing your code frequently, this is considered a good practice that makes things a lot easier.
- A wise guy has said Conventions Maketh Coder. So, ensure that you follow coding standards. This makes your code readable and understandable for others as well as you at a later point. You can use vigilance as well as editor/ide extensions to assist in this. Here are some coding standards for some popular languages:
- Every week, we will select the best attempt at solving the problem. Their code will be added here at the end of the event.
- If you get featured on a problem, you stand to win prizes and more !! (Submission Instructions)