Merge pull request #181 from mntnr/feat/dx-audit

docs: changes to README, Contribute, and scripts

CONTRIBUTING.md

@@ -9,6 +9,16 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel
 
 Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
 
+Want to get more involved with the Probot community? [Take a look at our community page](https://probot.github.io/community/)!
+
+## Issues
+
+We'd love you to open issues, if they're relevant to this repository: feature requests, bug reports, questions about our processes, declarations of gratefulness, etc. are all welcome.
+
+In particular, if you have a large PR you want to send our way, it may make sense to open an issue to discuss it with the maintainers first.
+
+We also use the label 'help wanted' to show issues we want help on! If you'd like to get started working in this repository, it'd be best to jump into those issues. View those issues [here](https://github.com/probot/probot.github.io/labels/help%20wanted)!
+
 ## Submitting a pull request
 
 1. [Fork][fork] and clone the repository
@@ -39,7 +49,7 @@ Work in Progress pull request are also welcome to get feedback early on, or if t
 
 You can add your app to the [website](https://probot.github.io/apps/) by creating a [new file in `_apps/`](https://github.com/probot/probot.github.io/new/master?filename=_apps/your-app-name.md) with this template:
 
-```
+```yaml
 ---
 # A human-friendly name of your listing
 title: Title of Your app
@@ -71,3 +81,13 @@ Any documentation can go here. Many apps just use their README.md here.
 - Has a license
 - Has a code of conduct
 - Has someone willing to at least minimally maintain them for the near future
+
+
+## Apps
+
+We have one app enabled on this repo:
+
+- [Stale](https://probot.github.io/apps/stale/): We use Stale to ensure that conversations here remain relevant. This is for us, the maintainers, so that we don't feel like we've got hundreds of issues to deal with; if you still have an issue, please let us know! We don't want to close issues that are painful for you. Stale just helps us have a bit more breathing space by making sure issues don't pile up forever.
+
+If you're concerned about our apps or feel that they are insensitive in some way, please let us know.
+

README.md

@@ -10,6 +10,34 @@ The majority of documentation on the site is drawn from [the probot docs](https:
 
 We also use this website to show off some of the cool probot apps built by the community. If you would like to have your app listed there, check out our [Contributing Guidelines](https://github.com/probot/probot.github.io/blob/master/CONTRIBUTING.md) for more information about what the requirements are to do that.
 
+## Install and Usage
+
+If you'd like to work on this repository, clone it. We use [Jekyll](https://jekyllrb.com/) to build the website, hosted on [GitHub Pages](https://pages.github.com/). We also use Git submodules to pull docs from the docs folder in  [probot/probot](https://github.com/probot/probot/tree/master/docs).
+
+Once you've cloned this repo, run these commands in this directory:
+
+```sh
+# Only needed the first time:
+$ script/bootstrap
+# And each time you work locally:
+$ script/server
+# Below is the expected output:
+Server address: http://127.0.0.1:4000
+Server running... press ctrl-c to stop.
+```
+
+You should then be able to navigate to the server address, and see live edits you make render in your browser. You'll likely have to familiarize yourself with how Jekyll works to do larger edits, but it's worth the effort!
+
+Another note: You can see more commands we use, such as our native build and server functions, in the [`script`](https://github.com/probot/probot.github.io/tree/master/script) folder. Go take a look!
+
+## Contribute
+
+We'd love to have you contribute! PRs are gladly accepted, and issues are also great. If you're thinking about a major PR, it would be better to open an issue first to talk about it.
+
+If you're interested in contributing, check out our [contributing docs](CONTRIBUTING.md) to get started.
+
+Want to get more involved with the Probot community? [Take a look at our community page](https://probot.github.io/community/)!
+
 ## License
 
 This website is licensed [CC-BY-4.0](LICENSE). The Probot logo is licensed [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en). It was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com.

script/bootstrap

@@ -4,9 +4,10 @@ set -e
 export CC=gcc
 
 echo "==> Installing gem dependencies…"
+which bundle || gem install bundle
 bundle check --path vendor/gems 2>&1 > /dev/null || {
   time bundle install --binstubs bin --path vendor/gems
 }
 
 echo "==> Getting submodule for docs…"
-git submodule update --init
+git submodule update --init --recursive