What should a project contain?

A project should contain a couple of things in order to make it easier for other developers to understand, build, test and maintain you code.

  • ReadMe file
    • How to build the project from command line
    • How to execute the tests from command line
    • How to create Code Coverage Report
    • Prerequisites for building
    • Should be on the root of the project
  • Stable Master Branch
    • Should always build
    • Should always have all tests success
    • Contain Git tag if it has been deployed

More here