Skip to content

Instantly share code, notes, and snippets.

@cjwd-snippets
Created March 9, 2017 15:58
Show Gist options
  • Select an option

  • Save cjwd-snippets/c405e3752cf53cd9ba44c3ae43c9c7cb to your computer and use it in GitHub Desktop.

Select an option

Save cjwd-snippets/c405e3752cf53cd9ba44c3ae43c9c7cb to your computer and use it in GitHub Desktop.
Starter readme file for my WordPress themes

General Information

This project uses the Gitflow Worflow.

You can learn more here

There are two branches Master and Dev. You will only need to concern yourself with the Dev branch.

The Dev branch will be used to integrate all the themes changes/features.

Getting Started

  1. Clone the central repository and create a tracking branch for develop:
git clone git@bitbucket.org:deviugo/comdev-website.git
git checkout -b dev bitb/dev

or HTTPS

git clone https://cjwd@bitbucket.org/deviugo/comdev-website.git 
git checkout -b dev bitb/dev

Steps in the workflow:

  1. Git Pull Rebase the lastest version of the development branch
  2. Create a Feature branch off your local development branch to do your changes
  3. Make commits
  4. Merge your changes into your development branch
  5. Push your changes to the Bitbucket development branch

Plugins

  • All plugins have been removed from the repo
  • Install plugins via the WordPress Dashboard
  • To indicate that a plugin is required add it to the composer.json file (follow the pattern there)
  • Plugin names and version are obtained from wpackagist.org
  • You can also add it to themes/mocd/libs/tgm-plugin-activation/required-plugins.php

Theme Changelog

Semantic Versioning is used

1.0.0: March 9, 2017

  • Initial Release
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment