From 538b7d61ffacc526310e999800966f149d278285 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Wed, 14 Feb 2024 15:14:28 -0500 Subject: [PATCH 1/2] add issue templates --- .github/workflows/ISSUE_TEMPLATE/config.yml | 13 +++ .../workflows/ISSUE_TEMPLATE/issue.bug.yml | 88 +++++++++++++++++++ .../ISSUE_TEMPLATE/issue.feature.yml | 37 ++++++++ README.md | 2 +- 4 files changed, 139 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ISSUE_TEMPLATE/config.yml create mode 100644 .github/workflows/ISSUE_TEMPLATE/issue.bug.yml create mode 100644 .github/workflows/ISSUE_TEMPLATE/issue.feature.yml diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/workflows/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..dab6197 --- /dev/null +++ b/.github/workflows/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: Mod list + url: https://mods.linuxserver.io + about: List of all mods published by Linuxserver.io. diff --git a/.github/workflows/ISSUE_TEMPLATE/issue.bug.yml b/.github/workflows/ISSUE_TEMPLATE/issue.bug.yml new file mode 100644 index 0000000..8968706 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/issue.bug.yml @@ -0,0 +1,88 @@ +# Based on the issue template +name: Bug report +description: Create a report to help us improve +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: Name of mod + description: Tell us the name of the mod this issue is about. + validations: + required: true + - type: textarea + attributes: + label: Name of base container + description: Tell us which base container the mod is being applied to. + validations: + 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 + - type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **How docker service was installed**: distro's packagemanager + value: | + - OS: + - How docker service was installed: + render: markdown + validations: + required: false + - type: dropdown + attributes: + label: CPU architecture + options: + - x86-64 + - arm64 + validations: + required: true + - type: textarea + attributes: + label: Docker creation + description: | + Command used to create docker container + Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container + render: bash + validations: + required: true + - type: textarea + attributes: + description: | + Provide a full docker log, output of "docker logs container_name" + label: Container logs + placeholder: | + Output of `docker logs container_name` + render: bash + validations: + required: true \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/issue.feature.yml b/.github/workflows/ISSUE_TEMPLATE/issue.feature.yml new file mode 100644 index 0000000..9245708 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/issue.feature.yml @@ -0,0 +1,37 @@ +# Based on the issue template +name: Feature request +description: Suggest an idea for this project +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: Name of mod + description: Tell us the name of the mod this feature request is about. + validations: + 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 \ No newline at end of file diff --git a/README.md b/README.md index 8db50bd..f018f61 100644 --- a/README.md +++ b/README.md @@ -269,7 +269,7 @@ GitHub Actions will trigger a build off of your repo when you commit. The image * Inspect the `root` folder contents. Edit, add and remove as necessary. * After all init scripts and services are created, run `find ./ -path "./.git" -prune -o ( -name "run" -o -name "finish" -o -name "check" ) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions. * Edit the readme with pertinent info. -* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic if needed. +* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed. * Ask the team to create a new branch named `<baseimagename>-<modname>` in this repo. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the [template branch](https://github.com/linuxserver/docker-mods/tree/template). * Submit PR against the branch created by the team. * Make sure that the commits in the PR are squashed. From 87598c1c4d42a694e8850c21fbc3b3e56e10d650 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Wed, 14 Feb 2024 15:16:40 -0500 Subject: [PATCH 2/2] fix folder structure --- .github/{workflows => }/ISSUE_TEMPLATE/config.yml | 0 .github/{workflows => }/ISSUE_TEMPLATE/issue.bug.yml | 0 .github/{workflows => }/ISSUE_TEMPLATE/issue.feature.yml | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename .github/{workflows => }/ISSUE_TEMPLATE/config.yml (100%) rename .github/{workflows => }/ISSUE_TEMPLATE/issue.bug.yml (100%) rename .github/{workflows => }/ISSUE_TEMPLATE/issue.feature.yml (100%) diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml similarity index 100% rename from .github/workflows/ISSUE_TEMPLATE/config.yml rename to .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/workflows/ISSUE_TEMPLATE/issue.bug.yml b/.github/ISSUE_TEMPLATE/issue.bug.yml similarity index 100% rename from .github/workflows/ISSUE_TEMPLATE/issue.bug.yml rename to .github/ISSUE_TEMPLATE/issue.bug.yml diff --git a/.github/workflows/ISSUE_TEMPLATE/issue.feature.yml b/.github/ISSUE_TEMPLATE/issue.feature.yml similarity index 100% rename from .github/workflows/ISSUE_TEMPLATE/issue.feature.yml rename to .github/ISSUE_TEMPLATE/issue.feature.yml