Tips on managing your repo

[real2two]

Credits: https://github.com/dudeisbrendan03 (I accidentally messed up the old repository.)

You're making something the community is using, so here are some tips:

• Add a valid license and remove the disclaimers, they carry no legal weight
• Add PR and issue templates
• Configure community
• Configure security automation/pipelining along with optimisation pipelines
• Automated testing (I highly recommend Azure DevOps for the above and this, their Ci/Cd is amazing)
• If this belongs to an organisation, move it to an organisation GitHub account
• Keep the README basic, no repeated content or useless headers. Write a descriptive wiki on installation, usage and advanced features
• Make API documentation
• Security contacts
• Do not commit to master, have a branch called dev and merge on each release
• Make sure your release names follow version standards (try to make use of milestones too), make the description contain the information about the release
• Better change logs
• Checksums with your releases
• Commits should have short titles with vague descriptions on the change and descriptions going into detail on the change
• Split each change up into commits, don't push them all at once
• Categorise your commits (https://gitmoji.carloscuesta.me/ is a fun easy way to spice up commits made and simplifying the process of finding what's changed and tracking down possible issues)
• SIGN YOUR COMMITS!!
• Utilise projects and boards built into GitHub for managing what you need to get done