Using README.md in all CF7 Skins Git repositories

Last Updated on February 7, 2018 by Neil Murray

We are now adding README.md in all CF7 Skins Git repositories.

Every directory in each repository should have a README.md (markdown syntax).

These README.md are really helpful. They provide quick and easy explanation at the location where the developer is currently looking (particularly useful for new developers).

Each README.md should contain:

  • brief description about directory
  • brief description for each file
  • approach explanation
  • public functions explanation and usage example
  • external link for documentation

Refer Documenting React Code in WordPress

One thought on “Using README.md in all CF7 Skins Git repositories

Leave a Reply

Your email address will not be published. Required fields are marked *