From 7ac8978a42e3d7a747cc3bdac7758465a70c3695 Mon Sep 17 00:00:00 2001 From: Igor Santos Date: Sun, 13 Nov 2016 19:15:17 -0200 Subject: [PATCH 1/2] Suggesting the use of local gems, as they're actually cleanable --- .gitignore | 2 ++ CONTRIBUTING.md | 2 +- _config.yml | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 0b09c01..0b1620d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ /_site/ *.DS_Store node_modules +vendor +.bundle diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d13345..2e3c849 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,7 +66,7 @@ included in the project: ```bash # Install the needed gems through Bundler - bundle install + bundle install --path vendor/bundle # Run the local server bundle exec jekyll serve ``` diff --git a/_config.yml b/_config.yml index fc11760..908205f 100644 --- a/_config.yml +++ b/_config.yml @@ -19,6 +19,6 @@ defaults: values: sitemap: false -exclude: ['CNAME', 'CONTRIBUTING.md', 'LICENSE', 'README.md', 'pages/example.md'] +exclude: ['CNAME', 'CONTRIBUTING.md', 'LICENSE', 'README.md', 'pages/example.md', 'vendor'] future: true From 12751015dfb826fd87cc1321d7e6c3157fbfd3b3 Mon Sep 17 00:00:00 2001 From: Igor Santos Date: Sun, 13 Nov 2016 19:15:35 -0200 Subject: [PATCH 2/2] Linking to CONTRIBUTING.md from the README contribution instructions, just in case --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7cffe99..a6f47f5 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ developers know where to find good information! ## How to Contribute +You should read the `CONTRIBUTING.md` file for precise instructions and tips. But, if you prefer a TL;DR: + 1. Fork and edit 2. Optionally install [Ruby](https://rvm.io/rvm/install/) with [Jekyll](https://github.com/mojombo/jekyll/) gem to preview locally 3. Submit pull request for consideration