Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.23 KB

Contributing to the GitHub Pages Gem

Before contributing be sure to read the project goals.

What to contribute

Anything that would make the GitHub Pages experience better for users. A few examples:

  • Pull requests suggesting that dependencies be bumped to new versions
  • Tools to make publishing to GitHub Pages easier
  • Things that make the experience simpler for less-technical users

What not to contribute

  • Features that belong in Jekyll core
  • Things that add complexity to the experience
  • Support questions, or general questions about Jekyll or GitHub pages (open an issue On Jekyll or contact [email protected])

How to contribute

  1. Fork the project
  2. Create a new, descriptively named branch
  3. Commit your proposed changes
  4. Submit a pull request

Testing with Bundler

To test your Gem with Bundler, you can:

  1. Create a directory

  2. Add a Gemfile like the following:

    gem 'github-pages', :git => 'https://github.com/<you>/pages-gem.git', :branch => '<your branch name>', :require => 'gh-pages'

  3. Execute bundle install

  4. Test