Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 5.79 KB

README.md

File metadata and controls

130 lines (90 loc) · 5.79 KB
Raw

ContriHUB Official Website

Hello Noobs 👋

Use this project to make your first contribution to the world of Open Source on GitHub :octocat: . Practice making your first pull request to a public repository before doing the real thing!

Join us by getting involved in the open source community solving some interesting tasks along the way.

This repository is open to all students of MNNIT.

Also note that this repository is part of ContriHUB, MNNIT's first OpenSource event in Avishkar 😃

Other repositories which are part of ContriHUB can be accessed here - ContriHUB

Make sure to get your GitHub Student Pack here: https://education.github.com/pack

What is ContriHUB?

A 25 days long contest from October 5th - October 29th to get people involved in Open Source. This repo is just the guide to get started on GitHub. We have a lot of different projects coming up. So start contributing and while you are at it, keep checking for more projects as they are added!

Choose any project and start fixing the issues. You can propose new features too !! Every feature you add or an issue you fix will fetch you some points according to the difficulty. At the end of the month, one who has the most points will be the winner. There are goodies waiting for you :P. Also, there are special arrangements just for first year. So, Stay tuned and keep checking the repos here for more projects and issues 😃

So, if you want to contribute to a particular project by either fixing an issue or adding a feature, all you have to do is

  • Fork the project
  • Create a new branch
  • Add a feature /fix the issue
  • Create a Pull Request
  • Submit the link to your Pull Request here
  • Wait for it to accept and grab your points 😃

Also, please make sure to follow the proper formatting such as

fixes #1

if you want your PR to be approved. The correct formatting should be followed. We won't help you there.

If you don't know what the above means , just keep reading ... you'll get there.

We will not be accepting more PR's until the formatting of the current files is fixed. Please fix those, referencing the issues present. Also note that the issues and the PR have common # numbers , so the first issue might not be #1 but could be #138 . Please check this before referencing the issue. Incorrect # numbers will not be merged.

How to contribute to this project

Here are 2 quick and painless ways to contribute to this project:

  • Add your name to the CONTRIBUTORS.md file
  • Add your entry to the participant.html file

Choose one or both, make a pull request for your work and wait for it to be merged!

Getting Started

  • Fork this repository (click the Fork button in the top right of this page, click your Profile Image)
  • Clone your fork down to your local machine
git clone https://github.com/your-username/XXXXX.git
  • Create a branch
git checkout -b branch-name
  • Make your changes (choose from any task below)
  • Commit and push
git add .
git commit -m 'Commit message'
git push origin branch-name
  • Create a new pull request from your forked repository (click the New Pull Request button located at the top of your repo)
  • Wait for your PR review and merge approval!
  • Star this repository ⭐ if you had fun!

Choose from these tasks

1. Add your name

Add your name to the CONTRIBUTORS.md file using the below convention:

#### Name: [YOUR NAME](Your Profile Link)
- Place: City, State, Country
- Bio: Who are you?
- GitHub: [Github account link](GitHub link)

2. Add name inside HTML

Firstly add your profile picture in 'profile' directory present under 'img' directory. Then in the participant.html file, look for the 'div' which contains the sample participant info. Then insert a new 'div' inside it with your profile details, in the format shown below -

<div class="col-auto" style="margin-bottom: 75px">
    <div class="card" style="width: 300px">
        <img class="card-img-top" src="{Link To Your Image}" alt="Card image">
        <div class="card-body">
            <h4 class="card-title">{Your Name}</h4>
            <p class="card-text">{Your Bio}</p>
            <a href="{Link To Your Github Profile}" class="btn btn-primary">See Profile</a>
        </div>
    </div>
</div>

Please do not remove the sample participant info otherwise your Pull Request will not be merged.

Reference links

Here is a great tutorial for creating your first pull request by Roshan Jossey: https://github.com/Roshanjossey/first-contributions

Managing your Forked Repo: https://help.github.com/articles/fork-a-repo/

Syncing a Fork: https://help.github.com/articles/syncing-a-fork/

Keep Your Fork Synced: https://gist.github.com/CristinaSolana/1885435

Checkout this list for README examples - Awesome README Awesome

Github-Flavored Markdown https://guides.github.com/features/mastering-markdown/

Contacts

For any query head on to dedicated Gitter Channel - ContriHUB

If you still have more doubts then feel free to ping any of the student co-ordinator.

Coordinators -