From 2227b678dd66ccee36e95e1a5192c2f67026f9e2 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 17:36:20 -0400 Subject: [PATCH 1/8] docs: Adding community fields --- package.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/package.json b/package.json index 12e9c71..0cdf6da 100644 --- a/package.json +++ b/package.json @@ -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", + "keywords": [ + "probot", + "github", + "probot-plugin", + "probot-app" + ], "scripts": { "dev": "nodemon --exec \"npm start\"", "start": "probot run ./index.js", From f08535e8d92c8c52936cc39dd5d101e3cdaeb267 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 17:36:41 -0400 Subject: [PATCH 2/8] docs: add travis badge, Contributing, License --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6409e51..4499347 100644 --- a/README.md +++ b/README.md @@ -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 }}) + +> 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 }}} From 36abb6685a6e7d84482d6004a4f44f58b03082b4 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 17:37:07 -0400 Subject: [PATCH 3/8] Add Slack, Issues, Apps section. Edit others --- CONTRIBUTING.md | 40 +++++++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94bd262..7883a66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. + + ## Resources From c94a7b527ce7a77139ed94b0a679fd3d8dd008ae Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 17:37:27 -0400 Subject: [PATCH 4/8] docs: Update with newer version It added socioeconomic status, mainly. --- CODE_OF_CONDUCT.md | 54 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 41 insertions(+), 13 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index db49d0b..6927b45 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,11 +2,17 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, race, +religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment include: +Examples of behavior that contributes to creating a positive environment +include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences @@ -16,31 +22,53 @@ Examples of behavior that contributes to creating a positive environment include Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or advances +* The use of sexualized language or imagery and unwelcome sexual attention or + advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. ## Scope -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at {{{ email }}}. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at {{{ email }}}. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ From 0fb21098f2f968da945356e472ae8066a32eaf58 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 31 May 2018 10:13:10 -0400 Subject: [PATCH 5/8] docs: remove mention of Slack --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7883a66..cc47814 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,14 +4,11 @@ [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. From fdd92c4f073d06a0c707b30e76cb8269195f5258 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 31 May 2018 10:13:21 -0400 Subject: [PATCH 6/8] docs: fix bot to apps --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc47814..803e666 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ Here are a few things you can do that will increase the likelihood of your pull Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you. - > A GitHub App built with [Probot](https://github.com/probot/probot) that {{ description }} From 8a970497ad9be4ee18b54df8679564c180a623bb Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 31 May 2018 10:13:59 -0400 Subject: [PATCH 8/8] docs: assume owner namespace, remove deprecated keyword --- package.json | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 0cdf6da..0558cf7 100644 --- a/package.json +++ b/package.json @@ -5,12 +5,11 @@ "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", + "homepage": "https://github.com/{{ owner }}/{{ repo }}", + "bugs": "https://github.com/{{ owner }}/{{ repo }}/issues", "keywords": [ "probot", "github", - "probot-plugin", "probot-app" ], "scripts": {