Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Create guide that explains how to learn/use git #3

Open
pocmo opened this issue Jun 26, 2018 · 6 comments
Open

Create guide that explains how to learn/use git #3

pocmo opened this issue Jun 26, 2018 · 6 comments
Labels
👩‍🎓user guide Docs for intro or how-to guide on topics we deal with

Comments

@pocmo
Copy link

pocmo commented Jun 26, 2018

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
Copy link
Author

pocmo commented Jun 26, 2018

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

@mcomella mcomella added the 👩‍🎓user guide Docs for intro or how-to guide on topics we deal with label Jul 28, 2018
@mcomella mcomella changed the title Create guide that explains how to contribute (git, github, pull requests) etc. Create guide that explains how to learn/use git Jul 28, 2018
@mcomella
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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

@mcomella
Copy link
Contributor

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

@Siddharth-coder13
Copy link
Contributor

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
👩‍🎓user guide Docs for intro or how-to guide on topics we deal with
Projects
None yet
Development

No branches or pull requests

3 participants