From e3ee9ba1132f9eaac272cdcf77fc1293a383bbb9 Mon Sep 17 00:00:00 2001 From: Florian Thomas Date: Wed, 20 Sep 2017 20:04:36 +0100 Subject: [PATCH] add note to contributing docs about `script/console` (#6349) Merge pull request 6349 --- .github/CONTRIBUTING.markdown | 4 ++++ docs/_docs/contributing.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.github/CONTRIBUTING.markdown b/.github/CONTRIBUTING.markdown index fe53b2f3..14cbecc1 100644 --- a/.github/CONTRIBUTING.markdown +++ b/.github/CONTRIBUTING.markdown @@ -111,6 +111,10 @@ If your contribution changes any Jekyll behavior, make sure to update the docume * Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't). +* You can use the command `script/console` to start a REPL to explore the result of +Jekyll's methods. It also provides you with helpful methods to quickly create a +site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console) + ## Running tests locally ### Test Dependencies diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md index b0b85e0f..391378f5 100644 --- a/docs/_docs/contributing.md +++ b/docs/_docs/contributing.md @@ -118,6 +118,10 @@ If your contribution changes any Jekyll behavior, make sure to update the docume * Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't). +* You can use the command `script/console` to start a REPL to explore the result of +Jekyll's methods. It also provides you with helpful methods to quickly create a +site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console) + ## Running tests locally ### Test Dependencies