diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 0000000..2e14178 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to help improve this project! Please read the [how to open an issue](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#how-to-open-an-issue) guide carefully before continuing. + + - type: checkboxes + id: latest + attributes: + label: "I've read the documentation" + options: + - label: I'm running the latest version of tubearchivist-jf-plugin. + required: true + - label: I have read the [how to open an issue](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#how-to-open-an-issue) guide, particularly the [bug report](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#bug-report) section. + required: true + + - type: input + id: os + attributes: + label: Operating System + description: On what operating system are you running Tube Archivist on? + placeholder: eg. Linux, Windows, ... + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: Your Bug Report + value: "## Describe the bug\n\n## Steps To Reproduce\n\n## Expected behavior" + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant Jellyfin log output + description: Please copy and paste any relevant Jellyfin logs. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 0000000..0f2136f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: I have an idea for a great addition to this project +title: "[Feature Request]: " + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to help improve this project! This project is *very* selective with accepting new feature requests. Please read the [how to open an issue](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#how-to-open-an-issue) guide carefully before continuing. + + - type: checkboxes + id: already + attributes: + label: "I've read the documentation" + options: + - label: I have read the [how to open an issue](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#how-to-open-an-issue) guide, particularly the [feature request](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#feature-request) section. + required: true + + - type: textarea + id: description + attributes: + label: Your Feature Request + value: "## Is your feature request related to a problem? Please describe.\n\n## Describe the solution you'd like\n\n## Additional context" + placeholder: Tell us what you see! + validations: + required: true + + - type: checkboxes + id: help + attributes: + label: Your help is needed! + description: This project is ambitious as it is, please contribute. + options: + - label: Yes I will work on this in the next few days or weeks. diff --git a/README.md b/README.md index 4646c0d..847a152 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ _NOTE: If you are using Docker containers, it is important to mount the TubeArch 2. Build plugin with following command ``` - dotnet publish Jellyfin.Plugin.tubearchivist-jf-plugin --configuration Release --output bin + $ dotnet publish Jellyfin.Plugin.TubeArchivistMetadata --configuration Release --output bin ``` 3. Place the dll-file in the `plugins/tubearchivist-jf-plugin` folder (you might need to create the folders) of your Jellyfin installation