From 1c8fe516a84b2b563dfa99d4c424937b7ff455a5 Mon Sep 17 00:00:00 2001 From: Roxedus Date: Tue, 27 Dec 2022 10:50:06 +0100 Subject: [PATCH] Add meta-files --- .github/CONTRIBUTING.md | 25 +++++++++++++ .github/FUNDING.yml | 2 ++ .github/ISSUE_TEMPLATE/config.yml | 13 +++++++ .github/ISSUE_TEMPLATE/issue.bug.yml | 36 +++++++++++++++++++ .github/ISSUE_TEMPLATE/issue.feature.yml | 31 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 25 +++++++++---- .../workflows/call-invalid-issues-cron.yml | 12 +++++++ .github/workflows/call_invalid_helper.yml | 12 +++++++ 8 files changed, 149 insertions(+), 7 deletions(-) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/issue.bug.yml create mode 100644 .github/ISSUE_TEMPLATE/issue.feature.yml create mode 100644 .github/workflows/call-invalid-issues-cron.yml create mode 100644 .github/workflows/call_invalid_helper.yml diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..ae97f83 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to reverse-proxy-confs + +## Gotchas + +* While contributing make sure to make all your changes before creating a Pull Request +* Read, and fill the Pull Request template + * If the PR is addressing an existing issue include, closes #\, in the body of the PR commit message +* If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://discord.gg/YWrKVTn) + +### Styling + +* Indentation: 4 spaces +* Line-endings: LF +* Trailing newline: yes + +### Requirements + +* Must have the date on the first line, in YYYY/MM/DD format +* For subdomains, add a comment for a needed CNAME +* If the application needs further configuration, specify this in a comment + +* In most cases we want the comments for Authelia, ldap and basic auth to be present +* If the application has known API endpoints, we prefer these to be exempt from auth trough a location block (provided the application has security on the endpoint) + +* Files must not be executeable diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..7eaac77 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: linuxserver +open_collective: linuxserver diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..5796fd3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,13 @@ +blank_issues_enabled: false +contact_links: + - name: Discord chat support + url: https://discord.gg/YWrKVTn + about: Realtime support / chat with the community and the team. + + - name: Discourse discussion forum + url: https://discourse.linuxserver.io + about: Post on our community forum. + + - name: Documentation + url: https://docs.linuxserver.io/general/swag#preset-proxy-confs + about: Documentation - information about how this repository works with SWAG. diff --git a/.github/ISSUE_TEMPLATE/issue.bug.yml b/.github/ISSUE_TEMPLATE/issue.bug.yml new file mode 100644 index 0000000..8a6b31e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.bug.yml @@ -0,0 +1,36 @@ +# Based on the issue template +name: Bug report +description: Create a report to help us improve. NOT TEMPLATE REQUESTS +title: "[BUG] " +labels: [Bug] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Current Behavior + description: Tell us what happens instead of the expected behavior. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: Tell us what should happen. + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/issue.feature.yml b/.github/ISSUE_TEMPLATE/issue.feature.yml new file mode 100644 index 0000000..66ca66f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.feature.yml @@ -0,0 +1,31 @@ +# Based on the issue template +name: Feature request +description: Suggest an idea for this project. NOT TEMPLATE REQUESTS +title: "[FEAT] <title>" +labels: [enhancement] +body: + - type: checkboxes + attributes: + label: Is this a new feature request? + description: Please search to see if a feature request already exists. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Wanted change + description: Tell us what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Reason for change + description: Justify your request, why do you want it, what is the benefit. + validations: + required: true + - type: textarea + attributes: + label: Proposed code change + description: Do you have a potential code change in mind? + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f6a6381..87e8888 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,14 +2,25 @@ [linuxserverurl]: https://linuxserver.io [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] - -<!--- Before submitting a pull request please check the following --> +------------------------------ -<!--- That you have made a branch in your fork, we'd rather not merge from your master --> -<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message --> -<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message --> -<!--- --> + - [ ] I have read the [contributing](https://github.com/linuxserver/reverse-proxy-confs/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications -## Thanks, team linuxserver.io +------------------------------ +<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. --> + +## Description +<!--- Describe your changes in detail --> + +## Benefits of this PR and context +<!--- Please explain why we should accept this PR. If this fixes an outstanding bug, please reference the issue # --> + +## How Has This Been Tested? +<!--- Please describe in detail how you tested your changes. --> +<!--- Include details of your testing environment, and the tests you ran to --> +<!--- see how your change affects other areas of the code, etc. --> + +## Source / References +<!--- Please include any forum posts/github links relevant to the PR --> \ No newline at end of file diff --git a/.github/workflows/call-invalid-issues-cron.yml b/.github/workflows/call-invalid-issues-cron.yml new file mode 100644 index 0000000..8c1aead --- /dev/null +++ b/.github/workflows/call-invalid-issues-cron.yml @@ -0,0 +1,12 @@ +name: Mark stale issues and pull requests +on: + schedule: + - cron: "30 1 * * *" + +jobs: + stale: + permissions: + issues: write + pull-requests: write + uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1 + secrets: inherit diff --git a/.github/workflows/call_invalid_helper.yml b/.github/workflows/call_invalid_helper.yml new file mode 100644 index 0000000..773767c --- /dev/null +++ b/.github/workflows/call_invalid_helper.yml @@ -0,0 +1,12 @@ +name: Comment on invalid interaction +on: + issues: + types: + - labeled +jobs: + add-comment-on-invalid: + if: github.event.label.name == 'invalid' + permissions: + issues: write + uses: linuxserver/github-workflows/.github/workflows/invalid-interaction-helper.yml@v1 + secrets: inherit