From 588326cd4606abe934775ad7eb34b8a5fd75ec98 Mon Sep 17 00:00:00 2001 From: Tyler Murphy Date: Tue, 21 Dec 2021 11:29:18 -0500 Subject: [PATCH] finalize docs --- .github/ISSUE_TEMPLATE/bug_report.md | 17 ++++++----------- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ README.md | 20 ++++++++++++++++++++ 3 files changed, 37 insertions(+), 11 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 README.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..bf64440 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: bug report assignees: '' --- @@ -23,16 +23,11 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +**System Info (please complete the following information):** + - OS: [e.g. Windows/Linux] + - Server Host [e.g. Apex/Custom] + - MC Version [e.g. 1.17/1.18] + - Plugin Version [e.g. 1.3.0/1.3.1 BETA] **Additional context** Add any other context about the problem here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..977e3be --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +**Describe the change** +A clear and concise description of what the changes are. + +**Expected behavior** +A clear and concise description of what your changes are going to do. + +**Screenshots** +If applicable, add screenshots to help explain your changes. + +**Additional context** +Add any other context about the pull request here. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d6a476 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +Kenshins Hide And Seek +====== + +Highly customizable hide and seek plugin + + +How To +----------- + +All Information on how to setup the plugin has +been moved to the github WIKI. + + +Compilation +----------- + +We use maven to handle our dependencies. + +* Install [Maven 3](http://maven.apache.org/download.html) +* Clone this repo and: `mvn clean install` \ No newline at end of file