Follow

Hey coding peeps! 👋 What project practice makes you smile when you join a community:

* concise commit messages?
* tons of inline code documentation?
* well maintained changelogs?
* code of conduct?

And what makes you go nuts?

@mray
I'm a documentation king, so I'd go for written example documentation (and not just inline docs)

@mray I like clean code that tries to cut down on unnecessary complexity. I try to stay away from over-reliance on frameworks, superfluous dependencies and chaotic code. On the project maintenance site, I appreciate clear and quick communication, even if it's just a "sorry, no time at the moment". An absolute show-stopper is a sloppy attitude towards licensing.

@mray Do you already feel comfortable sharing what the project is about?

@lhinderberger It is about gaming. I love gaming and can't stand how free software is not even remotely present there. I plan to get a FPS Battle Royal project up and running (Apex legends, PUBG, Fortnite...). I expect this to be out of pre-alpha within the next 20 years. Maybe.

@mray having the software itself well documented. all your software is worth nothing if nobody knows how to use it.

@mray@social.tchncs.de People being kind to newcomers is the biggest factor for me. Maintainers of some projects are bullies and very toxic, others are very nice and support newcomers in making their first contribution.

@mray I tend to think that wording of commit messages is very important.

Two examples:
1) Add X feature to systemComponentX
2) Added X feature to systemComponentX

1 is good and 2 is bad, 1 describes "what the commit contains" while 2 describes "what you did". The latter rather belongs in your time report to your manager while the former fits in both a commit log and a changelog.

Or even better:
1: [systemComponentX] Add feature X
2: Add feature X to systemComponentX

1 is better than 2 (imo)

@mray super-detailed guide to contributing, more examples of what to do than what not to do.

The first line of my contributing.md says simply "Contributing to this project is welcome!" and I like it.

Red flag: dismissive responses to issues

@mray Mostly good docs.

Contribution docs.
Setup/Install docs.
Requirements listed.
If you're targeting contributors, an easy way to get started - e.g a nice docker-compose file (depending on what you're working on)

@mray that the docs get updated with every added feature to the stable branch, so you dont have to seek out a maintainer to ask how the new features are activated/setup

@mray A commit log that isn't a informationless list of merges linking to GitHub issues.

@mray Docs. I swear to god I want good written docs. Having to read code to understand what a function does hurts my soul in so many ways

Sign in to participate in the conversation
Mastodon

The social network of the future: No ads, no corporate surveillance, ethical design, and decentralization! Own your data with Mastodon!