This is project checklist for any project (opensource or otherwise) made via PHP
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md
index.html

README.md

A PHP Project Checklist

NOTE: Please Fork this repo if you want to Add/Modify this checklist for project best practices.

  • Open Source Specific

    • ReadMe
      • It should contain the "Usage" section
      • It should contain the "Installation" section
      • It should contain the "Requirements" section
      • It should contain the "Contributing" section (via CONTRIBUTING file)
      • It should contain the "Credits" if you prefer
      • It should contain the "License" if you prefer (file "LICENSE" must be present in project root)
        • GPL: If you want any modified versions of your code to be used only in open-source software
        • LGPL: If your code is designed to be a standalone component that may be included in other applications without modification
        • MIT: Allows for use and redistribution of code so long as the license and copyright are included along with it.
  • Project Specific

    • Project Architecture Planning (decide which framework to use, which design patterns to follow: MVC, HMVC, DDD, etc)
    • Automated unit tests and builds to push update to the website
    • Proper folder structure such as src for source, vendor for dependencies, tests for tests, config, etc