Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

71%
+3 −0
#1: Initial revision by user avatar Monica Cellio‭ · 2022-05-17T03:07:02Z (almost 2 years ago)
How does a newcomer to Ruby get oriented in the qpixel code?
I am new to Ruby (and Rails) and have just (finally) succeeded in setting up qpixel on my Mac.  I headed over to our [easy GitHub issues](https://github.com/codidact/qpixel/issues?q=is%3Aissue+is%3Aopen+label%3A%22complexity%3A+easy%22) looking for something to use to get started, and then realized... wait, I don't know my way around this code base at all.  There are presumably conventions about what goes where, what the architecture is, etc that would be obvious to someone more experienced than I.

Is there an overview of the project for people like me?  Are there key files that I should look at first?  I looked for internal documentation but it's not in an obvious place (like a "doc" directory).  We do have an old [wiki](https://github.com/codidact/docs/wiki), but its focus is a little different (and did I say "old"?).

How do I get from an assertion on GitHub that an issue is "easy" to finding the right places in the code to start poking?  If there are tools that make this easier (what's the normal IDE for Ruby?), I'm interested in that too.