Skip to content
Martin Breuss edited this page Oct 22, 2016 · 2 revisions

If you're new to collaborating on a project (just like I am!) then there are a few things that might seems confusing at the beginning. Here are some basic things you'll encounter, and my thoughts on what I figured out, that will hopefully help you get started 😄 .

Basic Introduction

What's all this about?

We want to make an awesome project for Udacity Alumnis to connect, share, learn (you name it - you make it 🙂 )

How can I help and be part of creating this?

There is a ton of information in the dedicated wiki. Start reading there - or remember it as a place to go and check for solutions and pointers!

Issues

Okay, so you want to do something? Nice! 😄 Your search for tasks should lead you to the Issues tab in the github repo:

Here you can read about what is being aimed at and maybe you'll find something you find interesting.

That's where you can also add an issue if you encounter something is missing or going wrong.

Labels

Yep, those colored thingies that are stuck on the Issues. They mean things. Usually they should mean what they're called, so here's a short breakdown:

Legend explaining the Labels on Issues

(please feel free to correct and complete!)

general

  • discussion: A topic that is (hopefully) worth thinking, talking, and deciding about.
  • question: Something you were wondering about. This could be a question about a specific feature you think would be cool for the app, or also a more general question (like the what's all this for?)
  • help wanted: This issues needs personnel! Take a look, and if you like what you see it would be great if you could hop on the train : )
  • in progress: This one is not quite ready to be worked on. Something's still pending (e.g. a "good-to-go" response from the official Udacity side)
  • ready: Here's an issue that you can start working on right now. Start digging freely!
  • Pressing Matter: That one is important. Oh dear yes! Go go go. We need this done asap! 👟
  • enhancement: Working on this one will make the whole project become a better version of itself. Could be new features or improvements of already existing ones.
  • bug: Something's going wrong here. This needs a fix in the code.
  • invalid: The issue raised is not actually an issue. (explain why!)
  • wontfix: This is a hearty acknowledgement that something is not working, with the clarification that it's not worth the effort to fix it or that it would stray the project elsewhere (explain why!)
  • duplicate: This issue/question already came up and is discussed elsewhere (include a link to find that "elsewhere")

level of expertise

  • Easy for Newcomers: That's probably where you'll want to chime in! Those are tasks that are easier to do for someone new to this - but equally important as other aspects!
  • Medium: Difficulty raised one bar. Get your feet wet first, then hop onto these tasks
  • Challenging: Those ones are, well, challenging. We all know that's a good thing, so don't be afraid. 🙂 But no need to rush to red.

just fooling around

  • April Fools: I guess the name says it all. Nicely descriptive! Haha 😜

One more thing: Labels can be generated in the Labels tab. And here is how someone else is using them.

Waffleboard

For getting a hang on what is currently being worked on and what is waiting for helping hands, waffle is a useful app that integrates with the Issues in github. That means if you make something here, it'll be reflected in the github Issues and vice versa!

It's an easier way to keep track of tasks and I'd recommend using it over the Issues tab in github.