diff --git a/_apps/support.md b/_apps/support.md index 384e6bc..3367cfb 100644 --- a/_apps/support.md +++ b/_apps/support.md @@ -23,41 +23,48 @@ organizations: - crate - Laravel-Backpack --- - A GitHub App that comments on and closes issues labeled as support requests. ## Usage -1. [Install the GitHub App](https://github.com/apps/support) +1. **[Install the GitHub App](https://github.com/apps/support)** + for the intended repositories 2. Create `.github/support.yml` based on the template below 3. Start labeling issues as support requests +#### Configuration + Create `.github/support.yml` in the default branch to enable the app. The file can be empty, or it can override any of these default settings: -```yml +```yaml # Configuration for support-requests - https://github.com/dessant/support-requests # Label used to mark issues as support requests supportLabel: support -# Comment to post on issues marked as support requests. Add a link -# to a support page, or set to `false` to disable +# Comment to post on issues marked as support requests, `{issue-author}` is an +# optional placeholder. Set to `false` to disable supportComment: > - 👋 We use the issue tracker exclusively for bug reports and feature requests. - However, this issue appears to be a support request. Please use our - support channels to get help with the project. + :wave: @{issue-author}, we use the issue tracker exclusively for bug reports + and feature requests. However, this issue appears to be a support request. + Please use our support channels to get help with the project. # Close issues marked as support requests close: true # Lock issues marked as support requests lock: false + +# Assign `off-topic` as the reason for locking. Set to `false` to disable +setLockReason: true + +# Repository to extend settings from +# _extends: repo ``` ## Supporting the Project -Support Requests is an MIT-licensed open source project. Its ongoing -development is made possible thanks to the support of awesome backers. -If you'd like to join them, please consider contributing with -[Patreon](https://www.patreon.com/dessant). +The continued development of Support Requests is made possible +thanks to the support of awesome backers. If you'd like to join them, +please consider contributing with [Patreon](https://www.patreon.com/dessant).