Me and my new GitHub repository

hypnotic_nerd@programming.dev to Programmer Humor@programming.dev – 515 points –
14

You are viewing a single comment

I was chatting with a friend, and she mentioned how she tries to at least set up a README, which includes her vision for the project and her plan for the implementation, design, and goals.

Best case scenario is that the planning helps her complete the project herself. Worst case scenario, someone else can pick up where she left off and use her considerations for the project.

I'm thinking of doing that for future projects too

ReadMe is always underestimated while project is building, but it can become a cornerstone if it's setup from very beginning. Your friend is smart 👍

A Free Software License is even more important. There are many great projects out there which you can't modify etc. because the project isn't distributed with a license (which means "all rights reserved" in most jurisdictions).