shared-docs icon indicating copy to clipboard operation
shared-docs copied to clipboard

Create guide that explains how to learn/use git

Open pocmo opened this issue 7 years ago • 6 comments

Sometimes we get developers interested in contributing who do not have experience using git or github yet. It would be great to have a document explaining (or linking to good guides) how to fork a project, how to keep a local copy up to date, how to commit / amend / rebase / push and how to open a pull request and update it after review.

pocmo avatar Jun 26 '18 12:06 pocmo

This one seems to be close: https://gist.github.com/Chaser324/ce0505fbed06b947d962

pocmo avatar Jun 26 '18 12:06 pocmo

I think we should split how how we use GitHub + PRs and how to learn/use basic git (they can be in the same doc, but I think we should make it easy for experienced devs to use the former as a reference): I filed #16 for the former.

mcomella avatar Jul 28 '18 00:07 mcomella

We could also include links to docs that explain common problems, e.g. https://citizen428.net/10-common-git-problems-and-how-to-fix-them-e8d809299f08

mcomella avatar Jul 31 '18 21:07 mcomella

In #16, I created workflow documentation for experienced git/github users but we can elaborate on it for this issue.

mcomella avatar Jul 31 '18 22:07 mcomella

We should explain how to set up the committer email address - I've seen a few people forget to do that.

mcomella avatar Aug 16 '18 21:08 mcomella

I think this would be helpful for beginners. https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/GitHub And for making contribution https://github.com/firstcontributions/first-contributions/issues

Siddharth-coder13 avatar May 10 '20 09:05 Siddharth-coder13