Hey there, budding coders and OpenSource enthusiasts of IIT Mandi! ๐
Ever wondered why ants work together? No, it's not because they have tiny FOMO. It's because they realize that by working together, they can achieve so much more than by working alone. That's exactly why we want every single one of you to contribute to the CodeForge Repo this HacktoberFest! ๐๐
Why? Because together, we can create a robust codebase that will not only be an epitome of our combined coding prowess but also help all of us learn and grow. Imagine having a repository, by the IITians, for the IITians, helping us solve the daily coding blues for our college.
Not Registered Yet??! Start Hacking Here!!
Here's a cheatsheet to help you manage your Pull Requests:
Guide to Get You Started ๐:
Set Up Your Workspace and check out the "Issues" tab๐ฅ๏ธ: Before diving in, ensure you have a development environment set up. If youโre new, consider using a platform like Visual Studio Code, which is versatile and user-friendly.
Fork the Repository๐ด: Head over to Code-Forge Repository and click on the "Fork" button. This creates your own copy of the repository.
Clone Your Forked Repository ๐ฅ: On your forked repository, click the "Code" button and copy the URL. Then, in your terminal or command prompt, type
git clone URL
. Replace URL with the link you just copied.Create a New Branch ๐ฟ: Always make your changes in a new branch. This keeps things organized and avoids potential conflicts. Use the command
git checkout -b branch-name
.Make Your Changesโ๏ธ: Dive into the code, make your valuable contributions, and save the changes.
Commit and Push ๐: Commit your changes with a meaningful commit message. Use git add . followed by
git commit -m "Your message here"
. Then push the changes to your forked repo usinggit push origin branch-name
.Open a Pull Request (PR) ๐ค: Go back to the original Code-Forge Repository and click on "New Pull Request". Select your fork and the branch you worked on, then submit the PR with a clear description of your changes.
Wait for Review ๐: We will review your PR and might ask for some changes or improvements. Make sure to check your notifications!
Celebrate Your Contribution ๐: Once your PR gets merged, give yourself a pat on the back. You've contributed to the IIT Mandi community, and that's a big deal!
๐ General Guidelines for Contributing:
Clean and Readable Code: Remember, someone else will be reading your code. Or you might be reading your code six months down the line and wondering, "What sorcery is this?"
Comment When Necessary: Not everything in life needs an explanation, but your complex code snippets sure do.
Avoid Duplication: Before pushing a new algorithm or application, ensure that it doesn't already exist in the repository.
Stay Relevant: Make sure your contributions stick to the theme โ DSA, ML Algorithms, or applications to visualize/implement these algorithms.
๐ซ What Can Lead to PR Rejection:
- Plagiarism of any kind.
- Submitting someone elseโs work.
- Incomplete or broken code.
- Ignoring the general guidelines mentioned above.
Dive right in: Code-Forge Repository
Let's make this HacktoberFest memorable! Not just for the swag or the need to plant some trees for the planet, but because itโs a testament to what we can achieve together.
Letโs code, laugh, learn, and may the source (code) be with you! ๐๐
With ๐ from Akarshan & Biswadeep, your fellow IIT Mandi code-lovers!