Difference between revisions of "Getting started with GitHub"

Jump to: navigation, search
(Created page with "{{subst:Dime_wiki}}")
 
Line 1: Line 1:
<span style="font-size:150%">
This page provides resources and links to resources on how to get started with GitHub. There are other Git alternatives to GitHub but most of these resources are applicable to those alternatives as well. See for example [https://about.gitlab.com GitLab] and [https://bitbucket.org Bitbucket].
<span style="color:#ff0000"> '''NOTE: this article is only a template. Please add content!''' </span>
</span>


The World Banks GitHub repositories can be found at www.github.com/worldbank.


add introductory 1-2 sentences here
== Read First ==
*


== What GitHub is good at and what it is less good at ==
Git was implemented to manage code work and doing so by tracking changes made to code in great detail. This is the reason why Git is an amazing tool to collaborate on code, but the draw back is Git is only efficient in tracking changes to raw text files. All code files in any programming language are always raw text files, and so is .tex, .txt, .csv files, .doc/.docx, .xls.xlsx, .pdf files and images are examples of binary files that are not raw text files.  Binary file are stored very efficiently but Git does not have direct access to the text and numbers in those files and can therefore not track changes in detail. Git therefore stores one full version of binary files for each change made to them, which gets very inefficient. See the sections on [[Getting_started_with_GitHub#ignore_files | ignore files]] and [[Getting_started_with_GitHub#combining_GitHub_and_DropBox | combining GitHub and DropBox]] below for how to relate to this.


== Resources for absolute beginners ==
Since GitHub is used extensively outside the research community there are a lot of resources online on how to get started on GitHub. Some of those resources expect technical skills, but the list below links to resources that does not:
* https://guides.github.com/ - GitHub's own guide on how to get started


== Read First ==
== Best  practices for managing a research project using GitHub ==
* include here key points you want to make sure all readers understand
=== Ignore files ===
 
Ignore files is a very important tool to control what in your data work folder that you will share in the cloud. This is a good way to  


=== Ignore files ===
In research we often want to use a syncing service like DropBox, OneDrive etc. in combination with Git


== Guidelines ==
Some topics discusses in the GitHub guide are not relevant in research
* organize information on the topic into subsections. for each subsection, include a brief description / overview, with links to articles that provide details
* https://guides.github.com/features/issues/
===Subsection 1===
===Subsection 2===
===Subsection 3===


== Back to Parent ==
== Back to Parent ==
This article is part of the topic [[*topic name, as listed on main page*]]
This article is part of the topic [[Data Management]]
 
 
== Additional Resources ==
* list here other articles related to this topic, with a brief description and link


[[Category: *category name* ]]
[[Category: Data Management ]]

Revision as of 12:34, 17 May 2018

This page provides resources and links to resources on how to get started with GitHub. There are other Git alternatives to GitHub but most of these resources are applicable to those alternatives as well. See for example GitLab and Bitbucket.

The World Banks GitHub repositories can be found at www.github.com/worldbank.

Read First

What GitHub is good at and what it is less good at

Git was implemented to manage code work and doing so by tracking changes made to code in great detail. This is the reason why Git is an amazing tool to collaborate on code, but the draw back is Git is only efficient in tracking changes to raw text files. All code files in any programming language are always raw text files, and so is .tex, .txt, .csv files, .doc/.docx, .xls.xlsx, .pdf files and images are examples of binary files that are not raw text files. Binary file are stored very efficiently but Git does not have direct access to the text and numbers in those files and can therefore not track changes in detail. Git therefore stores one full version of binary files for each change made to them, which gets very inefficient. See the sections on ignore files and combining GitHub and DropBox below for how to relate to this.

Resources for absolute beginners

Since GitHub is used extensively outside the research community there are a lot of resources online on how to get started on GitHub. Some of those resources expect technical skills, but the list below links to resources that does not:

Best practices for managing a research project using GitHub

Ignore files

Ignore files is a very important tool to control what in your data work folder that you will share in the cloud. This is a good way to

Ignore files

In research we often want to use a syncing service like DropBox, OneDrive etc. in combination with Git

Some topics discusses in the GitHub guide are not relevant in research

Back to Parent

This article is part of the topic Data Management