Skip to content
This repository has been archived by the owner on Jan 26, 2021. It is now read-only.

Step by step guide for beginners #1116

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ankit-saraf
Copy link

@ankit-saraf ankit-saraf commented Sep 13, 2020

Description

Created BEGINNER_GUIDE.md file

Fixes #1111

Type of Change:

  • Documentation

Checklist:

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials
  • Any dependent changes have been merged

BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
BEGINNER_GUIDE.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Sep 14, 2020

Codecov Report

❗ No coverage uploaded for pull request base (develop@6fc528d). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop    #1116   +/-   ##
==========================================
  Coverage           ?   86.93%           
==========================================
  Files              ?       85           
  Lines              ?     4057           
  Branches           ?      237           
==========================================
  Hits               ?     3527           
  Misses             ?      458           
  Partials           ?       72           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6fc528d...22dbb79. Read the comment docs.

@vj-codes
Copy link
Member

@ankit-saraf hey the doc looks good now, can you please squash the commits then I can give a final look and approve

@ankit-saraf
Copy link
Author

@ankit-saraf hey the doc looks good now, can you please squash the commits then I can give a final look and approve

@vj-codes Can u please tell me how to do that

@vj-codes
Copy link
Member

@ankit-saraf
Copy link
Author

ankit-saraf commented Sep 14, 2020

@ankit-saraf Check this out https://gist.github.com/longtimeago/f7055aa4c3bba8a62197

Should i use git rebase -i upstream/master @vj-codes

@vj-codes
Copy link
Member

@ankit-saraf yes , if you did git pull from master branch
cc : @sanchibansal340 @keshakaneria while squashing commits we rebase from master branch right?Thanks!

@keshakaneria
Copy link
Member

keshakaneria commented Sep 14, 2020

@ankit-saraf yes , if you did git pull from master branch
cc : @sanchibansal340 @keshakaneria while squashing commits we rebase from master branch right?Thanks!

No, if the PR is sent from master branch then only we need to squash them in master branch. So the thing you should take care is use the branch where you were working from. You can read more this here.
You can use git rebase - i HEAD~n where n is the number of commits you want to squash from the latest commits you have done.

@ankit-saraf
Copy link
Author

Seems like I overwrote the changes that I did here on Github.
Thank god before squashing I took backup :)

BEGINNER_GUIDE.md updated

BEGINNER_GUIDE.md mistakes corrected

corrected file
@ankit-saraf
Copy link
Author

@vj-codes Pls review. I squashed all the commits.

Copy link

@SanketDG SanketDG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guides like this exist all over the internet.

My only concern with such guides: there is a very high chance that we forget something and we mislead the contributor into doing something else because we forgot about one little step.

I'd really love this to exist in sort of a meta-site, maybe documentation? But it makes no sense to be in vms.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Step by step guide for absolute beginners to contribute
4 participants