From deb9d97d3738b9732fc59a96665d7593d06bdeff Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Thu, 10 Jan 2019 23:20:58 -0500 Subject: Update issue templates Adds issue templates for Bugs, Features, and Enhancements. --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement-request.md | 20 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++++++ 3 files changed, 66 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..c6d2b4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a bug report +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**System (please complete the following information):** + - OS: [e.g. Docker, Debian, Windows] + - Browser [e.g. Firefox, Chrome, Safari] + - Version [e.g. 10.0.1] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.md b/.github/ISSUE_TEMPLATE/enhancement-request.md new file mode 100644 index 0000000000..57c0d4cae2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement-request.md @@ -0,0 +1,20 @@ +--- +name: Enhancement request +about: Suggest an modification to an existing feature +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..a2ce072452 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest a new feature +title: '' +labels: feature +assignees: '' + +--- + +**Describe the feature you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here. -- cgit v1.2.3 From 874a6bf38b2c60dadfc10ee1f5100391d5f1b19a Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Thu, 10 Jan 2019 23:25:58 -0500 Subject: Update pull request template --- .github/pull_request_template.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .github/pull_request_template.md (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..0edc492187 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,6 @@ +**Changes** +Describe your changes here in 1-5 sentences. + +**Issues** +Tag any issues that this PR solves here. +Fixes # -- cgit v1.2.3 From f818053a435650239f9f2c38281d63a95eb0a64b Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Thu, 10 Jan 2019 23:41:40 -0500 Subject: Update bug_report.md Add section about log files. --- .github/ISSUE_TEMPLATE/bug_report.md | 3 +++ 1 file changed, 3 insertions(+) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c6d2b4bb38..e5210b1c4e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -20,6 +20,9 @@ Steps to reproduce the behavior: **Expected behavior** A clear and concise description of what you expected to happen. +**Logs** +Please paste any log errors. + **Screenshots** If applicable, add screenshots to help explain your problem. -- cgit v1.2.3 From f1d6f0457207e176a3d093f90c5933372f7900b2 Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Thu, 10 Jan 2019 23:42:56 -0500 Subject: Consistent formatting for System fields --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e5210b1c4e..b4e340d39c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -28,8 +28,8 @@ If applicable, add screenshots to help explain your problem. **System (please complete the following information):** - OS: [e.g. Docker, Debian, Windows] - - Browser [e.g. Firefox, Chrome, Safari] - - Version [e.g. 10.0.1] + - Browser: [e.g. Firefox, Chrome, Safari] + - Version: [e.g. 10.0.1] **Additional context** Add any other context about the problem here. -- cgit v1.2.3 From 2e53f4c2e95dca85d7f7f82e075f008c0a321e87 Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Fri, 11 Jan 2019 10:40:14 -0500 Subject: Add blurb about title --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0edc492187..9a0cde9be9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,5 @@ +Ensure your title is short, descriptive, and in the imperative mood (Fix X, Change Y, instead of Fixed X, Changed Y). + **Changes** Describe your changes here in 1-5 sentences. -- cgit v1.2.3 From c28283aa7cd765bdb89a4c6eda25d7dde8927f75 Mon Sep 17 00:00:00 2001 From: Vasily Date: Fri, 11 Jan 2019 22:05:27 -0500 Subject: Be explcit about what the version is Co-Authored-By: joshuaboniface --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b4e340d39c..4abd39cfc5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -29,7 +29,7 @@ If applicable, add screenshots to help explain your problem. **System (please complete the following information):** - OS: [e.g. Docker, Debian, Windows] - Browser: [e.g. Firefox, Chrome, Safari] - - Version: [e.g. 10.0.1] + - Jellyfin Version: [e.g. 10.0.1] **Additional context** Add any other context about the problem here. -- cgit v1.2.3 From dadd6e11b1806892ec3217b84594c038e6e784e6 Mon Sep 17 00:00:00 2001 From: Vasily Date: Fri, 11 Jan 2019 23:02:51 -0500 Subject: Add link to writing good messages article Co-Authored-By: joshuaboniface --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9a0cde9be9..ac1ddcb3ef 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,5 @@ Ensure your title is short, descriptive, and in the imperative mood (Fix X, Change Y, instead of Fixed X, Changed Y). +For a good inspiration of what to write in commit messages and PR have a look at https://chris.beams.io/posts/git-commit/ **Changes** Describe your changes here in 1-5 sentences. -- cgit v1.2.3 From 03ec62e478f781e789d61418161816e27d248068 Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Fri, 11 Jan 2019 23:05:38 -0500 Subject: Add link to our contributing docs as well --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ac1ddcb3ef..b2b3cf241e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ Ensure your title is short, descriptive, and in the imperative mood (Fix X, Change Y, instead of Fixed X, Changed Y). -For a good inspiration of what to write in commit messages and PR have a look at https://chris.beams.io/posts/git-commit/ +For a good inspiration of what to write in commit messages and PRs please review https://chris.beams.io/posts/git-commit/ and our https://jellyfin.readthedocs.io/en/latest/developer-docs/contributing/ page. **Changes** Describe your changes here in 1-5 sentences. -- cgit v1.2.3 From e04f652eff8f4acbbbf664bb7bf318eefd492f20 Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Fri, 11 Jan 2019 23:12:28 -0500 Subject: Add Master codeowners In conjunction with branch protection rules, this will require approval from the Org owners (myself or @nvllsvm) before a merge can be accepted. --- .github/CODEOWNERS | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .github/CODEOWNERS (limited to '.github') diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..7185aa7321 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# Jellyfin CODEOWNERS file (`master` branch) + +# Require org owner approvals for all files, when merging to master +* @joshuaboniface @nvllsvm -- cgit v1.2.3 From 78a5d999f4e5c92dfc70d4428f88a3c6597dea9d Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Sat, 12 Jan 2019 16:10:51 -0500 Subject: Delete CODEOWNERS from dev branch This was removed from master but wasn't transitioned with that merge because of GitHub being annoying and treating CODEOWNERS differently in each branch. --- .github/CODEOWNERS | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 .github/CODEOWNERS (limited to '.github') diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 7185aa7321..0000000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,4 +0,0 @@ -# Jellyfin CODEOWNERS file (`master` branch) - -# Require org owner approvals for all files, when merging to master -* @joshuaboniface @nvllsvm -- cgit v1.2.3