docs: improve community documentation #62
Conversation
It added socioeconomic status, mainly.
CONTRIBUTING.md
Outdated
|
|
||
| ## Apps | ||
|
|
||
| Not surprisingly, we have some GitHub Apps using Probot enabled on this repo: |
CONTRIBUTING.md
Outdated
| Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you. | ||
| Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you. | ||
|
|
||
| <!-- Add any bots you enable in this section. Here is an example: |
| @@ -1,6 +1,8 @@ | |||
| # {{ name }} | |||
|
|
|||
| > a GitHub App built with [probot](https://github.com/probot/probot) that {{ description }} | |||
| [](https://travis-ci.org/probot/{{ name }}) | |||
There was a problem hiding this comment.
I'm a little conflicted about having the travis badge right here, since I'm not sure we wanna "endorse" any specific CI service, even though we do use Travis. Do you think that's okay still?
There was a problem hiding this comment.
I think it's OK. I'll add a comment saying add your own CI service.
package.json
Outdated
| "keywords": [ | ||
| "probot", | ||
| "github", | ||
| "probot-plugin", |
There was a problem hiding this comment.
we deprecated use of probot-plugin, so I'd prefer it not be included for any new apps
There was a problem hiding this comment.
I would remove it from the GitHub keywords, then. :)
package.json
Outdated
| @@ -5,6 +5,14 @@ | |||
| "author": "{{{ author }}}", | |||
| "license": "ISC", | |||
| "repository": "https://github.com/{{ owner }}/{{ repo }}.git", | |||
| "homepage": "https://probot.github.io/apps/{{ name }}/", | |||
| "bugs": "https://github.com/probot/{{ name }}/issues", | |||
There was a problem hiding this comment.
homepage assumes that the App will get listed on the website which is not necessarily true, so maybe assume they start out with their readme as homepage:
"homepage": "https://github.com/{{ owner }}/{{ repo }}/blob/master/README.md"
but that's also kinda gross, so maybe just the same as the repository field's link?
bugs also assume that the repo of the app will be within the probot org which is actually pretty unlikely, the probot org is only home to a few select "OG" probot apps. so maybe:
"bugs": "https://github.com/{{ owner }}/{{ repo }}/issues",
CONTRIBUTING.md
Outdated
| @@ -4,29 +4,51 @@ | |||
| [pr]: /compare | |||
| [style]: https://standardjs.com/ | |||
| [code-of-conduct]: CODE_OF_CONDUCT.md | |||
| [slack]: https://probot-slackin.herokuapp.com/ | |||
There was a problem hiding this comment.
Do you think this is worthwhile to include here since not all app creators might want to redirect to our "official" slack?
See #61