How to Contribute
If you DONT know how to code
You can take part in this initiative by sending me files (notes, questions, solutions) whatever you come across, that you might find helpful. The semester does not matter. Send me whatever you get your hands on.
Sending me? How
Sending me files is a cumbersome process right now. Sit tight, an uploader is being worked on. It should be here in a few months. Till then, I implore you to email me your notes and stuff. I’ll be manually adding them to the collection for everybody to benefit.
If you know how to code, this is the barebones
graph TD;
A(Decide to Contribute) -->|fork the repository| B[Make Desired Changes]
B --> C{Is Change Good?}
C -->|NO| D[Make it good]
D --> C
C -->|YES| E[Good! You're ready to share it with everybody]
E -->|commit and push to your forked repository| F(Make a pull request)
I am a bit confused
This walkthrough assumes that you have made a github account prior to doing this
- Fork this entire repository
- Make desired changes
- Such as adding files to
content/
- Deleting content deemed unnecesary
- Adding resources such as Questions/Notes/Links etc
- Determine if the changes you’ve made is good
- A good change is one which does not break the system
- The first thing to ensure is that your repo is not behind the master when pushing. Learn to be a commit ahead.
- If that seems hard^, then atleast make sure there are no conficting changes
- Ofcourse, bad commits are NOT ignored but, bad commits will take longer to appear on the main website.
- Lastly, don’t sweat the details. If you feel its good, push it. Moderators won’t let anything that shouldnt break, break.
- Now, if the change your propose is good to go, please commit it one final time then push to your
master
- Then you need to make a pull request from your forked repository.
- Once your pull request is submitted, moderators will make sure necessary changes are made. Your contributions are valuable to us.
- Expect to see YOUR content soon! You are now an official contributor. Yes, our website automatically enlists you in the contributor list as long as you have configured your Git-bash properly
- Thanks for contributing!