{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "---\n", "output:\n", " html_document: default\n", " pdf_document: default\n", "---\n", "\n", "# Task 1: How to set up a repository on GitHub\n", "\n", "This task is designed for students and researchers who want to create their first Open Source project (software or non-software) on GitHub. GitHub is a place for you to come and play and experiment with new research workflows, and is really just the beginning to help set the stage for your own pathways and ideas.\n", "\n", "Don't forget you can join in the discussions over at our open [**Slack channel**](https://openmooc-ers-slackin.herokuapp.com/). Please do introduce yourself at #module5opensource, and tell us a bit about who you are, your background, and how you ended up here!\n", "\n", "**PLEASE NOTE** that a screen recording for this task is also available via [YouTube](https://www.youtube.com/watch?v=AnftV9HBPSc&).\n", "\n", "Estimated time to complete: 30-45 minutes.\n", "\n", "Estimate time saving once complete: Unimaginable..\n", "\n", "## Table of contents\n", "\n", "* [Getting started](#Getting_started)\n", " * [Setting up a GitHub profile](#Profile)\n", " * [The GitHub language](#Language)\n", " * [Creating a new repository](#Create_new)\n", "* [The foundational steps](#Foundation)\n", " * [Choosing a license](#License)\n", " * [Creating a README file](#Readme)\n", " * [Creating contributing guidelines](#Contributing)\n", " * [Creating a code of conduct](#Conduct)\n", " * [Making your code citable](#Citation)\n", "* [Keeping your issues up to date](#Issues)\n", "* [Check-list for launching your project](#Check-list)\n", "\n", "
\n", " \n", "
\n", "\n", "The workflow for Task 1. Keep this handy as you work through the task!
\n", "\n", "\n", " \n", "
\n", "\n", "Octocat, GitHub's little mascot
\n", "\n", "Sign up for GitHub
\n", "\n", "\n", " \n", "
\n", "\n", "Unbeatable guide to using Git. (Source: XKCD)
\n", "\n", "Create a new repository
\n", "\n", "The basic repository structure
\n", "\n", "Choosing an example license
\n", "\n", "Part of the README file for this module
\n", "\n", "Part of the `CONTRIBUTING` guidelines for this module
\n", "\n", "Part of the CODE OF CONDUCT file for this module, based on the Contributor Covenant
\n", "\n", "The issue tracker for the Open Scholarship Strategy project
\n", "\n", "