Open Source Summer - Week 2

Introduction to Open Source

Welcome to Open Source Summer Week 2!

Week 1 Spotlight

Last week, we received 20+ PRs to our graffiti wall 😮!! Thank you to everyone who tagged our wall and we hope you learned something useful from that challenge!

Here are some cool tag designs you all made 😎

View the full wall here!

Week 2 Overview

Last week, we went over the git workflow and how to make pull requests in Github. This week, we’ll be looking at Github “Issues” and its role within the open source ecosystem.

Github Issue Tracking

Many open source projects use Issues as a method for communication, collaboration, and task/project management. By default, every Github repository has an Issues section.

Issues are used to:

• Request new features/enhancements

• Report bugs

• Keep track of tasks/TODO’s

A typical Issues section looks like this:

Fun fact 🎈: We used Issues to keep track of the different sections we need to complete for Open Source @ UCSD’s Constitution!

Components of an Issue

• A title and description describe what the issue is all about.
• Color-coded labels help you categorize and filter your issues (just like labels in email).
• A milestone acts like a container for issues. This is useful for associating issues with specific features or project phases (e.g. Weekly Sprint 9/5-9/16 or Shipping 1.0).
• One assignee is responsible for working on the issue at any given time.
• Comments allow anyone with access to the repository to provide feedback
  

(Source: https://guides.github.com/features/issues/)

How do I create an Issue?

1. On GitHub, navigate to the main page of the repository.
2. Under your repository name, click  Issues.
3. Click New issue.
   
4. If there are multiple issue types, click Get started next to the type of issue you'd like to open.
5. Type a title and description for your issue.
6. If you're a project maintainer, you can assign the issue to someone, add it to a project board, associate it with a milestone, or apply a label.
7. When you're finished, click Submit new issue.

(Source: https://help.github.com/en/articles/creating-an-issue)

Creating Good Issues

This resource gives you some tips and advice on how to make good issues on Github 💯

Open Source Casino/Arcade 🎰🃏

Open Source Casino/Arcade is (will be!) a collection of games built by the open source community @ UCSD - meant to help people new to open source get more comfortable with proposals, pull requests, and programming in the open source world

Link to Open Source Casino/Arcade repo

Weekly Challenge #2: Idea Incubator 💡

Brainstorm one or a few games that you, or others, could implement. Submit an issue on our Open Source Casino repository with a proposal of your idea, using the guidelines and template we created!

Refer to Casino README and How do I create an Issue? for step-by-step instructions.

Here are a few example proposals from our community:

  🐍 Snek - a snake-like game on the console, in Python (from Chris)

  ⚪ Breakout - a re-make of the classic arcade game, in Javascript/HTML/CSS (from Chau)

  🦝 Flappy Raccoon - re-make of flappy bird with a UCSD twist, in Javascript/HTML/CSS (from Vivian)

Inspiration

Don’t know what game to propose? Here are some resources to get you inspired!

Games

• Simple games: rock-paper-scissors, tic-tac-toe
• Simple board games: Connect 4, Crocodile Dentist
• Simple Card games: Blackjack/21, War, Crazy Eights
• Arcade games: Pong, Breakout,
• “Paper and Pencil” games: Battleship, MASH
• Retro: Oregon Trail, pong, snake
• Trivia games, typing games, memorization games
• For fun: Chrome’s “No internet” dino game, 2048, Flappy Bird

Example Game implementations

• Glitch’s games section (Javascript, html, css)
• Codepen.io search for “games” (Javscript, html, css)
• Github’s #console-game topic or #terminal-game (Many languages!)
• Github user leereilly’s list of games hosted on Github (Many languages)

Languages Choice

Choose something you know and are comfortable with! Or, use this as an opportunity to pick up a language you’ve been wanting to learn. Here’s a list of some languages you can do - but feel free to use any not on this list:

• Java, C, C++
• Javascript, HTML, CSS (if you want something in the browser)
• Ruby, Golang, Rust
• Python, R, Julia
• Typescript, Kotlin, C#, Swift

Sneak Peek for Next Week: 🛠

If you haven’t already, follow us on these platforms to keep updated!

   Facebook Page and Facebook Group

 Discord server

      Github

See you all next week! More exciting things to come in the future 🚀 In the meantime, if you have some spare time, we would appreciate it if you could leave us some anonymous feedback about this week’s email!