Does your project already have a descriptive README?
From time to time we happen to encounter projects that don't even share the most basic information of what they are supposed to be, or if they do, not in a way that everyone can understand.
Do you feel busted? 😉 Go ahead and add some lines during our #Docuthon!
@codeberg aaand please, not just "this is a project written in WTFlang using best practice and latest bah" – or "foobar is an app for foobar". Write what your project *is about*, which audience you target, and some basic usage ideas. Thanks!
@codeberg maybe you can help by providing a great skeleton or template?
One that captures best practices, hands structure to developers and can act as a checklist for devs setting up projects.
I myself turned https://github.com/othneildrew/Best-README-Template into a template. But there are other such examples.
Yeah, we have one 😉 At least in our main repository base:
(GB) #lerntools #docuthon #codeberg
@codeberg I remember one of my first more substantial (but still non-collaborative) projects, I didn't even add a make file.. I just uploaded an executable! 😂
And don't forget to specify THE LICENSE!
Without any Open Source license, the code IS closed source and cannot be used by anyone without your explcit authorization.
This Mastodon instance is for people interested in technology. Discussions aren't limited to technology, because tech folks shouldn't be limited to technology either!