this post was submitted on 19 Feb 2024
39 points (95.3% liked)

Programming

17675 readers
57 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago
MODERATORS
snowe
Ategon
[email protected]
39
When you look at some random project's source code for the first time how do you assess time, quality, and complexity at first glance? (lemmy.world)
submitted 10 months ago by [email protected] to c/programming
11 comments fedilink hide all child comments
 

I'm just generalizing, like if you want to copy some cleaver feature or modify some Python program you came across, what are the red or green flags indicating how well your (or particularly some hobbyist's/your early learning self's) results are likely to turn out?

Also how can you tell when reading into such a project is going to be a major project that is beyond the scope of you ultimate goals. For instance, I wanted to modify Merlin 3d printer firmware for hardware that was not already present in the project, but as an Arduino copy pasta hobbyist, despite my best efforts, that was simply too much for me to tackle at the time because of the complexity of the code base and my limited skills.

How do you learn to spot these situations before diving down the rabbit hole? Or, to put it another way, what advice would you give yourself at this stage of the learning curve?

you are viewing a single comment's thread
view the rest of the comments
[–] onlinepersona 13 points 10 months ago (1 children)

TL;DR I look at the package first, before opening it. Unfortunately, often the packaging says a lot about the project

  1. A proper README
  2. A section in the README about how to setup a dev environment - without that it's often just a guessing game I don't have time for
  3. A section in the README about how to deploy or run the project
  4. Test cases that actually mean something, not just boilerplate assert true
  5. Some kind of CI setup with steps for code quality (lint, format, type checking, ...)
  6. Documentation generation
  7. Pull/merge requests / external project activity

Some programming languages still have either no tooling or communities that shun it. C, C++ and PHP come to mind. Many projects from those languages are written by old folk, people who only use editors (vim, emacs, nano, ...) that don't come with tooling out of the box, or assume a might amount of things about dev machines. They are languages and communities I shun.

Go, Python, Rust, Typescript, and other languages are chock-full of developer tooling with people using IDEs or at least editors with extensions/plugins for improved developer lives. Especially Rust and Typescript are often setup with a bunch of tooling that has to be actively ignored by the developer. Often it's much easier to get started, run the project, run tests, read the code, load it into an IDE or editor with advanced language support (goto definition, refactoring, integrations for running and testing code, ...).

CC BY-NC-SA 4.0

[–] [email protected] 3 points 10 months ago (2 children)

A section in the README about how to setup a dev environment - without that it's often just a guessing game I don't have time for

Software brittleness

Preferable to not require a special setup.

[–] Lucky 6 points 10 months ago

Even if you don't have a special setup, having a section telling you that is still a helpful thing to quickly assess a new project.

I appreciate knowing that a project should Just Work with minimal setup so I don't have to guess or make assumptions

[–] onlinepersona 0 points 10 months ago

Preferable to have a description of a setup at all instead of

"just" ./config && make install

CC BY-NC-SA 4.0