-
Notifications
You must be signed in to change notification settings - Fork 166
docs: improve community documentation #62
Changes from 4 commits
2227b67
f08535e
36abb66
c94a7b5
0fb2109
fdd92c4
6ed2bc6
8a97049
7865b4a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,29 +4,51 @@ | |
[pr]: /compare | ||
[style]: https://standardjs.com/ | ||
[code-of-conduct]: CODE_OF_CONDUCT.md | ||
[slack]: https://probot-slackin.herokuapp.com/ | ||
|
||
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
||
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 chat with Probot users and contributors? [Join us in Slack][slack]! | ||
|
||
## Issues and PRs | ||
|
||
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them. | ||
|
||
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR. | ||
|
||
## Submitting a pull request | ||
|
||
1. [Fork][fork] and clone the repository | ||
1. Configure and install the dependencies: `npm install` | ||
1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so no need to lint seperately | ||
1. Create a new branch: `git checkout -b my-branch-name` | ||
1. Make your change, add tests, and make sure the tests still pass | ||
1. Push to your fork and [submit a pull request][pr] | ||
1. [Fork][fork] and clone the repository. | ||
1. Configure and install the dependencies: `npm install`. | ||
1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately. | ||
1. Create a new branch: `git checkout -b my-branch-name`. | ||
1. Make your change, add tests, and make sure the tests still pass. | ||
1. Push to your fork and [submit a pull request][pr]. | ||
1. Pat your self on the back and wait for your pull request to be reviewed and merged. | ||
|
||
Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
||
- Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test` | ||
- Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test`. | ||
- Write and update tests. | ||
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
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: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: apps* |
||
|
||
## Apps | ||
|
||
Not surprisingly, we have some GitHub Apps using Probot enabled on this repo: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. <3 this wording! |
||
|
||
// Replace this section below | ||
- [Stale](https://probot.github.io/apps/stale/): We use Stale (the app created in this repo) 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. | ||
|
||
--> | ||
|
||
## Resources | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,8 @@ | ||
# {{ name }} | ||
|
||
> a GitHub App built with [probot](https://github.com/probot/probot) that {{ description }} | ||
[![Build Status](https://travis-ci.org/probot/{{ name }}.svg?branch=master)](https://travis-ci.org/probot/{{ name }}) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it's OK. I'll add a comment saying add your own CI service. |
||
|
||
> A GitHub App built with [Probot](https://github.com/probot/probot) that {{ description }} | ||
|
||
## Setup | ||
|
||
|
@@ -11,3 +13,13 @@ npm install | |
# Run the bot | ||
npm start | ||
``` | ||
|
||
## Contributing | ||
|
||
If you have suggestions for how {{ name }} could be improved, or want to report a bug, open an issue! We'd love all and any contributions. | ||
|
||
For more, check out the [Contributing Guide](CONTRIBUTING.md). | ||
|
||
## License | ||
|
||
[ISC](LICENSE) © {{{ year }}} {{{ author }}} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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: 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: |
||
"keywords": [ | ||
"probot", | ||
"github", | ||
"probot-plugin", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we deprecated use of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would remove it from the GitHub keywords, then. :) |
||
"probot-app" | ||
], | ||
"scripts": { | ||
"dev": "nodemon --exec \"npm start\"", | ||
"start": "probot run ./index.js", | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think this is worthwhile to include here since not all app creators might want to redirect to our "official" slack?