Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
urgetolearn authored Jul 7, 2024
1 parent 185f87f commit 3675d00
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
## NITK- SUMMER OF CODE
![alt text]([Uploading Screenshot 2024-07-07 005651.png…])
!([Uploading Screenshot 2024-07-07 005651.png…])
## What is NITK-SOC?
Contributing to open-source projects during college is immensely beneficial for students. It offers real-world experience in software development, collaboration, and problem-solving, which are invaluable in a professional setting. Joining such communities right from college gives additional boost and confidence for tackling industrial needs. In our open-source initiative, mentors and project administrators will be *seniors and alumni from NITK Surathkal*, bringing their wealth of experience and expertise to guide new contributors. Conversely, Mentees can be *students from any college*, creating a diverse and inclusive environment for learning and collaboration. This structure ensures that mentees receive top-notch guidance from seasoned professionals while fostering a broad and vibrant community of learners and contributors.

Contributions are always welcome! Follow these steps to get started:
1. 🍴 **Fork this repository.**
+ Click the Fork button at the top-right corner of this repository page to create a copy of the repository under your GitHub account.
> Click the Fork button at the top-right corner of this repository page to create a copy of the repository under your GitHub account.
2. 📥 **Clone your forked copy of the project.**
+ git clone https://github.com/<your-username>/NITK-Summer-Of-Code.git
> git clone https://github.com/<your-username>/NITK-Summer-Of-Code.git
3. 📂 **Change the working directory.**
+ cd NITK-Summer-Of-Code
> cd NITK-Summer-Of-Code
4. 🔗 **Add a reference to the original repository.**
+ git remote add upstream https://github.com/urgetolearn/NITK-Summer-Of-Code.git
> git remote add upstream https://github.com/urgetolearn/NITK-Summer-Of-Code.git
5. 🔍 Check the remotes for this repository.
+ git remote -v
> git remote -v
6. **⬇️ Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project.**
+ git pull upstream main
> git pull upstream main
7. 🌿 **Create a new branch.**
+ git checkout -b <your_branch_name>
> git checkout -b <your_branch_name>
You are all set! 🎉
8. **🛠️ Perform your desired changes to the code base.**
9. 📊 **Track your changes.**
+ git add .
> git add .
10. 💬 **Commit your changes with a relevant commit message.**
+ git push -u origin <your_branch_name>
> git push -u origin <your_branch_name>
11. 🔄 **To create a pull request,** go to your forked repository on GitHub and click on Compare & pull request.
12. 🎉 Congratss! You have made a PR!!

Expand Down

0 comments on commit 3675d00

Please sign in to comment.