git_get_started.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Table of Contents\n",
    "\n",
    "- [Getting Started](#getting-started)\n",
    "    - [Setting up softwares](#setting-up-softwares)\n",
    "    - [Setting up git](#setting-up-git)\n",
    "    - [Forking and Cloning](#forking-and-cloning)\n",
    "    - [Making branches](#making-branches)\n",
    "    - [Editing files](#editing-files)\n",
    "    - [Adding and commiting changes](#adding-and-commiting-changes)\n",
    "    - [Pushing changes and submitting a Pull Request](#pushing-changes-and-submitting-a-pull-request)\n",
    "- [Resources](#resources)\n",
    "- [Rules and Scoring System](#rules-and-scoring-system)\n",
    "- [FAQ](#faq)\n",
    "\n",
    "  \n",
    "# Getting Started\n",
    "\n",
    "\n",
    "[This repo](https://github.com/10acad/git-get-started.git) is to help newbies get started with Open Source. The objective of this tutorial is to make your first Pull Request and add your name to the [contributors](contributors/) folder. \n",
    "\n",
    "## Setting up softwares\n",
    "\n",
    "To work on Github hosted projects, one has to use Git - a Version Control System. So the first task is to install git on your machine. For Windows users, download git from here - https://git-scm.com/downloads. For Linux users, you can use your distro's package manager to install git.\n",
    "\n",
    "**Note:** Although Linux isn't mandatory, it is preferred while working with Open Source Software.\n",
    "\n",
    "**Note:** You can learn about Version Control Systems (VCS) [here](https://www.atlassian.com/git/tutorials/what-is-version-control).\n",
    "\n",
    "## Setting up git\n",
    "\n",
    "After installing git, run git and execute these commands:\n",
    "\n",
    "```\n",
    "git config --global user.name \"[name]\"\n",
    "git config --global user.email \"[email address]\"\n",
    "```\n",
    "\n",
    "That should complete the software setup.\n",
    "\n",
    "## Forking and Cloning\n",
    "\n",
    "Before you can edit any file on the repo, you must fork and clone it. A **fork** is a copy of the repository in your account. To **clone** a repo means to download it locally. Click the Fork button on the top right of this repo to fork it. Next, go to your copy of the repo and click the Clone button. Copy the url. Now open git and execute this command:\n",
    "\n",
    "```\n",
    "git clone [copied url here]\n",
    "```\n",
    "\n",
    "That should download the repo locally.\n",
    "\n",
    "## Making branches\n",
    "\n",
    "A **branch** is a parallel copy of the code. When we add new features to a project, we usually create a copy of the code and work on it. This is done so that the main working copy of the code is unaffected. In most GitHub repos, the master branch is the default branch. You should create a separate branch for every contribution you make. To create a new branch, execute this command:\n",
    "\n",
    "```\n",
    "git checkout -b [branch name here]\n",
    "```\n",
    "\n",
    "You should see the branch name change on the terminal prompt. Congratulations! You created a new branch.\n",
    "\n",
    "\n",
    "## Editing files\n",
    "\n",
    "Create a new text file in the [contributors](contributors/) folder with your github handle as the file name. This file should contain your name. A sample file [yabebalFantaye.txt](contributors/yabebalFantaye.txt) has been provided.\n",
    "\n",
    "## Adding and commiting changes\n",
    "\n",
    "To create a **commit** means to save your work. But before you commit, you have to **add** your work to the commit. To do so, execute this command from the project root:\n",
    "\n",
    "```\n",
    "git add *\n",
    "```\n",
    "\n",
    "This adds all files to the upcoming commit. Now, to create the commit run this command:\n",
    "\n",
    "```\n",
    "git commit -m \"[commit message here]\"\n",
    "```\n",
    "\n",
    "Write any message in place of the commit message. If the command runs successfully, you should have committed your changes.\n",
    "\n",
    "## Pushing changes and submitting a Pull Request\n",
    "\n",
    "After committing your changes, you have to upload them to GitHub. This is known as **pushing**. To push your changes, run:\n",
    "\n",
    "```\n",
    "git push origin [branch name]\n",
    "```\n",
    "\n",
    "Where branch name is the name of your newly created branch. This should upload your changes to *your* GitHub account. Now, you can propose these changes to the actual project. To do so, click on the **Pull Request** button on GitHub. Most of the fields should be automatically filled out for you. Click Create Pull Request. If everything went correctly, you should have created a pull request with your changes. Now it is upto the repo owner to **merge** these changes.\n",
    "\n",
    "Congratulations! You made your first Open Source Contribution! Now contribute to some other repos on NWoC. Have a great time!\n",
    "\n",
    "# Resources\n",
    "\n",
    "You can learn more about Git and GitHub here:\n",
    "\n",
    "- https://www.youtube.com/watch?v=w3jLJU7DT5E\n",
    "- https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940\n",
    "\n",
    "# Rules and scoring system (normlaised to 100 points)\n",
    "\n",
    "- **30 point** for contributing to this repo by adding a file, namely [YourGitHubUsername].txt which contains your name, to the [contributors](contributors) folder.\n",
    "- **30 points** for opening a legitimate issue (errors you find) on the twitter_minning.ipynb notebook. For simplicity the original twitter_mining.ipynb is provided in the [twitter_mining](twitter_mining) folder.\n",
    "- **40 points** for providing a pull request by adding a working twitter_mining.ipynb as [YourGitHubUsername].ipynb to [twitter_mining](twitter_mining) folder. In particular, this cell in your notebook should work without error. \n",
    "\n",
    "```python\n",
    "    covid_keywords = '#COVID19 OR #COVID19Africa'  #hashtag based search\n",
    "    tweets_file = 'data/ethiopia_covid19_23june2020.json'\n",
    "    #get data on keywords\n",
    "    ts = tweetsearch()\n",
    "    df = ts.get_tweets(covid_keywords, csvfile=tweets_file)    #you saved the \n",
    "```\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python [conda env:.conda-10x]",
   "language": "python",
   "name": "conda-env-.conda-10x-py"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}