Contributing to YeoPress is simple. A Vagrant configuration is bundled with these files, so to get a test server up and running requires a single command. Make sure you have VirtualBox and Vagrant installed, then run:
$ vagrant up
Vagrant will provision a new virtual machine, and setup everything you need to run WordPress and Yeoman.
$ vagrant ssh
Welcome to your Vagrant-built virtual machine.
$ cd www
$ yo wordpress
The virtual machine has port 8080 forwarding to the test site which is located in test/site. So to check things in the browser, you simply open http://localhost:8080 and you should see your WP install.
If you prefer to work locally without Vagrant, you can link the cloned repository with npm:
$ git clone [email protected]:<Your User Name>/YeoPress.git generator-wordpress && cd generator-wordpress
$ sudo npm link
$ cd /path/to/where/you/want/to/test/run/the/generator && yo wordpress
Now any changes you make in to the generator will be instantly available when you run the generator. Also, the --verbose flag is very helpful in diagnosing problems.
Please make all pull requests to the develop branch. Example process for making a PR:
- Fork and clone repo
$ git co -b feature-my-awesome-thing- Makes changes and commit
- Push changes to GitHub
- Create PR from
feature-my-awesome-thingon your repo todevelopon the main repo - Celebrate for giving back to OSS!!
Please make all pull requests to the develop-theme branch. Example process for making a PR:
- Fork and clone repo
$ git checkout develop-theme$ git checkout -b feature-my-awesome-theme-thing- Makes changes and commit
- Push changes to GitHub
- Create PR from
feature-my-awesome-thingon your repo todevelopon the main repo - Celebrate for giving back to OSS!!
To work on your changes, you will need to push your branch and point the generator at your fork:
[?] GitHub username: <Your User Name>
[?] GitHub repository name: YeoPress
[?] Repository branch: <Your Branch>