Giter Club home page Giter Club logo

intro-to-open-source's Introduction

Workshop: Intro to Open Source ๐Ÿš€

This repo is for our Women Who Code 2017 Intro to Contributing to Open Source Workshop. This repo serves as a safe test space for those who wish to practice git, making pull requests and responding to issues.

Workshop Agenda

  • Overviewing GitHub and Releases
  • Reviewing the Basics and Learning a Codebase
  • Your First Open Source Project Commit (look for First Timer's Only PRs)
  • What to expect - will my PR be merged in right away? How do deal with feedback?
  • Becoming a Regular Contributor

Usage

In the Issues tab, we have a variety of issues with different labels that you can choose. Choose from any of the labels and submit a PR with your changes. We'll review your PR and conduct a mock code review, before ultimately merging your PR.

If you have any questions about working in existing open source libraries, open a new issue!

Git Config

First you should tell git your name and email (You can set specific ones for different repositories if you wish.). So if you're Scott Hanselman, you'd do it like this:

git config --global user.name "Scott Hanselman"
git config --global user.email [email protected]

If you want to set up a default editor you can set it using:

git config --global core.editor vim

To see what configuration settings you have:

git config --list

Getting an existing repository

To clone this respository, click the green clone or download button above, pick HTTPS or SSH and copy the link. For HTTPS you can just add .git to the URL https://github.com/intelsdi-x/snap.git. git-clone

After copying the link, go to the path on your own computer that you want to clone this to. For organization it is more clear when there are separate directories for different repo owners.

Making a new branch

Say you want to make changes on a branch other than master. This is common when wanting to separate different changes. If you want to have the exact

Pulling down new content

  • git fetch: fetches the changes, but doesn't merge them
  • git pull: does git fetch and git merge. This results in an extra commit.
  • git pull --rebase: leaves your commits in a straight line without branches

Contributing to Open Source

Creating an Issue

Click the button at the top that says "Issues" and then the green button to the right. create-issue

Creating a Pull Request

Click the button at the top that says "Pull Requests" and then the green button to the right. create-pr If the pull request (PR) is to fix an existing issue, you can reference it by #somenumber, e.g. #2. It's common to say "Fixes #somenumber" so when the PR is merged, it closes the corresponding issue.

Tip: Include the issue the PR fixes in the commit message and have descriptive messages.

Resources

Great websites for people who are new to coding/contributing to open source:

Some Git/GitHub Resources

Contributing to an Open Source Project

intro-to-open-source's People

Contributors

vertedinde avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.