aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml39
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml5
-rw-r--r--.github/pull_request_template.md12
-rw-r--r--CONTRIBUTING.md21
5 files changed, 75 insertions, 7 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..c5be7ab
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,39 @@
+name: Bug Report
+description: File a bug report
+labels: "bug"
+body:
+- type: markdown
+ attributes:
+ value: Before raising an issue, please search for existing issues to avoid creating duplicates. For questions and support please use [Discord](https://polyfrost.cc/discord).
+- type: textarea
+ id: bug-description
+ attributes:
+ label: Bug description
+ description: Summarize the bug encountered concisely
+ validations:
+ required: true
+- type: textarea
+ id: version-data
+ description: The version data e.g: Minecraft 2.10.2, OneConfig v0.1-alpha, Windows 12, etc.
+- type: textarea
+ id: steps-to-reproduce
+ attributes:
+ label: Steps to reproduce
+ description: Describe the steps to reproduce the issue
+ validations:
+ required: true
+- type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected behavior
+ description: Describe what you should see instead
+- type: textarea
+ id: example-repository
+ attributes:
+ label: Example repository
+ description: If possible, please create an [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug and link it here in the bug report
+- type: textarea
+ id: anything-else
+ attributes:
+ label: Anything else?
+ description: Let us know if you have any additional feedback!
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..7263137
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Discord Server
+ url: https://polyfrost.cc/discord
+ about: Please ask and answer usage questions here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..b4ed087
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,5 @@
+---
+name: Feature request
+about: Suggest an idea for OneConfig
+
+---
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..4c4529d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,12 @@
+## Description
+<!-- Describe your changes in detail -->
+
+## Related Issue(s)
+<!-- List the issue(s) this PR solves -->
+
+## Checklist
+- [ ] I proved a clear description of what was change
+- [ ] I stated why this change was necessary
+- [ ] I updated documentation or said what needs to be updated
+- [ ] I made sure this change is backwards compatible
+- [ ] This pull request is for one feature/bug fix
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d7042f7..0035f22 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,19 +1,26 @@
# Contributing
-We recommend the use of an IDE, specifically [Intellij Idea](https://www.jetbrains.com/idea/). This guide will be based on Intellij and might be slightlmy different for other Ides.
+We recommend the use of an IDE, specifically [IntelliJ IDEA](https://www.jetbrains.com/idea/). This guide will be based on IntelliJ and might be slightly different for other IDE's.
+
### Prerequisites
-- A Java 17 or up JDK
-- A Java 8 JDK
-### Setting up IDE
-Your project JDK should be set to Java 8, to do this in Intellij go to `File > Project Structure` and set `SDK` to your Java 8 JDK.
+- A Java 17 or up JDK.
+- A Java 8 JDK.
+
+### Setting up your IDE
+
+#### IntelliJ IDEA:
+Your Project JDK should be set to Java 8, to do this in IntelliJ go to `File > Project Structure` and set `SDK` to your Java 8 JDK.
+
Your Gradle JDK should be set to Java 17 or up, to do this in Intellij go to `File > Settings > Build, Execution, Deployment > Build Tools > Gradle` and set `Gradle JVM` to a Java 17 JDK.
-Then you might have to reload your Gradle project, to do this click Gradle in the top right and then click the reload button.
+
+You might have to reload your Gradle project, to do this click Gradle in the top right and then click the reload button.
Now in the Gradle tab under the `loom` you should run the `setupGradle` task and then under the `ide` tab you should run the `genIntellijRuns` task.
This will allow you to run Minecraft with your ide and use the debugger.
To login in to your Minecraft account while in your development enviroment, we recommend the use of [DevAuth](https://github.com/DJtheRedstoner/DevAuth)
# Pull Requests
-To add your code to OneConfig, please open a pull request.
+To contribute to OneConfig, please open a pull request. Here are the basic guidelines.
+
Guidelines for pull requests:
- **Clear description**: Make sure you document **what** was changed and **why** the change was needed.
- **One pull request per feature**: Please open an individual pull request for each new feature or for each bug fix, this makes it easier for us to keep track of everything.