Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Guide to hacking

Jump to bottom
Jason Kridner edited this page Jun 10, 2020 · 4 revisions

This is targeting the folks at Major League Hackers. It is mostly put here to avoid distractions as Robert made this Github project specifically to target features to be developed for our next software release as a catch-all project. I'd previously started some hacks at describing the gamification of Beagle development to try to on-board people, but we'll start a bit clean-and-fresh here as that one never got and feedback. We have a fair bit more experience on-boarding through https://beagleboard.org/gsoc.

Anyway, good first issues will be recorded on this Github project with the tag good first issue.

As an introductory exercise, I'd suggest going through the workshop-slides and workshop-handouts at https://github.com/beagleboard/cloud9-examples/tree/v2020.01/PocketBeagle/TechLab. See also http://bbb.io/t. If you find bugs, file them at https://github.com/beagleboard/cloud9-examples/issues and provide pull-requests to fix them.

Why and how do you typically contribute to an open source project?

How do you get help?

Please, please, please read http://www.catb.org/~esr/faqs/smart-questions.html

TL;DR

  1. Don't be shy. Have thick skin. Don't take or make things personal on-line. It is OK to be clueless and to be told you are clueless. That's why you are here. If anyone around the project harasses you, contact me.
  2. Don't ask to ask, just ask. No one likes to waste their time telling you to please go ahead and ask your question.
  3. When you ask:
    • Describe what you want to accomplish. A short, clear, complete and honest description of what you'd consider success will go a long way, rather than saying "I don't get it" or "Nothing's working". We can't help you if you can't say what you want to try to do.
    • If you haven't tried something already, try something. Once you tried and failed, describe what you tried, how you came to that as a possible approach, and what result you got that was different than you expected. It is valid to say "I thought I'd learn how to do X by reading Y, but I still don't know how to do X". It is not OK to say "How do I do X" without having searched for the answer already.
  4. Be patient and persistent.

Clone this wiki locally