Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (58 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

77 lines (58 loc) · 2.44 KB

Contributing Guide

We love contributors and people willing to help. Open an issue or send us pull request:

  • Fork this repository over GitHub
  • Create a new branch for instance patch-1 so you will not need to rebase your fork when the master branch changes. 
    git clone git@github.com:your_username/wwphp-fb.github.io --recursive
cd wwphp-fb.github.io
git checkout -b patch-1
  • Edit the content of the repository, commit changes and push to your fork 
    git add .
git commit -m "Fix typo"
git push origin patch-1
  • Send us pull request

Installation

Ruby and Jekyll are required to view the wwphp-fb.github.io GitHub site locally. Install Jekyll according to the documentation and inside the repository directory use Bundler to install the needed gems and build the site:

bundle install
bundle exec jekyll serve --force_polling

Jekyll inside a Vagrant box

If you use Vagrant forward port 4000 (default port) to 4000 and run Jekyll:

jekyll serve --host 0.0.0.0

Docker

If you use Docker a convenient way to run Jekyll and GitHub pages is Jekyll image. Command for running a Docker container:

docker run --rm --label=jekyll --volume=/path/to/wwphp-fb.github.io:/srv/jekyll -it -p 127.0.0.1:4000:4000 jekyll/jekyll:pages bash
bundle exec jekyll serve

Preview of generated static files can than be viewed at http://localhost:4000.

Build

PHP related contents (FAQs, articles and best practices) are located in a separate php-resources repository. When these contents changes, build.php script can be used to generate search index:

sudo sh -c "curl http://get.sensiolabs.org/melody.phar -o /usr/local/bin/melody && chmod a+x /usr/local/bin/melody"
melody run build.php -vvv

Build script uses melody - one file Composer scripts.

License

By contributing to this repository you agree to share your knowledge under the Creative Commons Attribution 4.0 International License and your code under the MIT license.