-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev-1.12.2' into release-1.12.2
- Loading branch information
Showing
49 changed files
with
1,244 additions
and
879 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,5 @@ build | |
# other | ||
eclipse | ||
run | ||
secrets.json | ||
.gradle | ||
/secret.json | ||
build.properties |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
|
||
# How to contribute | ||
|
||
We want to keep it as easy as possible to contribute changes. | ||
There are a few guidelines that we need contributors to follow | ||
so that we can keep on top of things. | ||
|
||
## Getting Started | ||
|
||
### Submitting Changes | ||
|
||
* Submit an issue to the github project, assuming one does not already exist. | ||
* Clearly describe the issue including steps to reproduce when it is a bug. | ||
* Make sure you fill in the earliest version that you know has the issue. | ||
* Waiting for feedback is suggested. | ||
* Fork the repository on GitHub | ||
* Create a topic branch from where you want to base your work. | ||
* This `dev-1.12.2` branch that is under active development. | ||
* Only target the Release branch | ||
* To quickly create a topic branch based on the development branch; `git | ||
checkout -b my_contribution_branch`. Please avoid working | ||
directly on the `dev-1.12.2` branch. | ||
* Make commits of logical units. | ||
* Check for unnecessary whitespace with `git diff --check` before committing. | ||
* Make sure your commit messages are in the proper format. | ||
|
||
```` | ||
(#12345) An Example Commit Message Adding An Example Feature/Fix | ||
If your commit requires additional information for the developers | ||
you can add it after the first line with a space. | ||
The first line must contain your issue/suggestion ticket # | ||
```` | ||
* Always fully test your changes. | ||
* Describing the process you used to test your changes in detail will help speed up this process. | ||
|
||
## Making Trivial Changes | ||
|
||
### Documentation | ||
|
||
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new issue. | ||
We usually use `squash and merge`. | ||
```` | ||
### Semantic Changes | ||
In order to keep the code in a state where PRs can be safely merged, it is important to | ||
avoid changes to syntax or changes that don't add any real value to the code base. PRs | ||
that make changes only to syntax or "clean up" the code will be rejected. Any code clean-up | ||
should be coordinated with the core team first. | ||
# Additional Resources | ||
* [General GitHub documentation](http://help.github.com/) | ||
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,105 @@ | ||
# GalacticTweaks | ||
GalacticTweaks | ||
|
||
<h1 align="center"> | ||
<br> | ||
<img src="https://i.imgur.com/ucMiR5q.png" alt=""> | ||
</h1> | ||
|
||
|
||
|
||
<h2 align="center">[ ~ The Galacticraft Tweaker Mod ~ ]</h2> | ||
<h3 align="center">That's Not A CraftTweaker Addon</h3> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/ReadOnly-Mods/GalacticTweaks/blob/dev-1.12.2/LICENSE"></a> | ||
<img src="https://badgen.net/github/license/micromatch/micromatch" | ||
alt="MIT License"> | ||
<a href=""></a> | ||
<img src="https://img.shields.io/github/v/release/ReadOnly-Mods/GalacticTweaks?style=flat-square&label=Release"> | ||
<a href=""></a> | ||
<img src="https://badgen.net/badge/Made%20With/Love/pink" | ||
alt="Made With love"> | ||
</p> | ||
<p align="center"> | ||
<a href="https://www.curseforge.com/minecraft/mc-mods/galactictweaks"> | ||
<img src="http://cf.way2muchnoise.eu/full_galactictweaks_downloads.svg"> | ||
<a href="https://www.curseforge.com/minecraft/mc-mods/galactictweaks"> | ||
<img src="http://cf.way2muchnoise.eu/versions/galactictweaks.svg"> | ||
</p></a> | ||
|
||
## Table of Contents | ||
|
||
* [About](#about) | ||
* [Issues](#issues) | ||
* [Building](#building) | ||
* [Contribution](#contribution) | ||
|
||
## About | ||
|
||
A tweaks mod for the Galacticraft Mod. As the name implies it adds various tweaks to give additional gameplay options, also contains fixes for various mechanics where needed or wanted by popular/personal opinion. | ||
|
||
## Issues | ||
|
||
GalacticTweaks crashing, have a suggestion, found a bug? Create an issue now! | ||
|
||
1. Make sure your issue has not already been answered or fixed and you are using the latest version of this mod and Galacticraft. Also think about whether your issue is a valid one before submitting it. | ||
* If it is already possible with vanilla, within Galacticraft, another Addon or This mod itself, the suggestion will be considered invalid. | ||
* Asking for a back-port to an older Minecraft version will also be considered invalid | ||
2. Go to [the issues page](https://github.com/ReadOnly-Mods/GalacticTweaks/issues) and click [The Provided Template](https://github.com/ReadOnly-Mods/GalacticTweaks/issues/new/choose) | ||
3. use one of the provided templates. It will also contain further details about required or useful information to add. Failure to follow the template will result in your suggestion/issue being closed | ||
4. Click `Submit`, and wait for feedback! | ||
|
||
Providing as many details as possible does help us to find and resolve the issue faster and also you getting a fixed version as fast as possible. | ||
|
||
Please note that we might close any issue not matching these requirements. | ||
|
||
## Building | ||
|
||
1. Clone this repository via | ||
- SSH `git clone git@github.com:ReadOnly-Mods/GalacticTweaks.git` or | ||
- HTTPS `git clone https://github.com/ReadOnly-Mods/GalacticTweaks.git` | ||
2. Build using the `gradlew build` command. Jar will be in `build/libs` | ||
3. For core developer: Setup IDE | ||
- IntelliJ: Import as gradle project | ||
- Eclipse: Import as gradle project or execute gradle task `eclipse` and potentially `setupDecompWorkspace` | ||
|
||
## Contribution | ||
|
||
Before adding major changes, you might want to discuss them with us first. | ||
If you are still willing to contribute to this project, you can contribute via [Pull-Request](https://help.github.com/articles/creating-a-pull-request). | ||
|
||
The [guidelines for contributing](https://github.com/ReadOnly-Mods/GalacticTweaks/blob/dev-1.12.2/CONTRIBUTING.md) contain more detailed information about topics like the used code style and should also be considered. | ||
|
||
Here are a few things to keep in mind that will help get your PR approved. | ||
|
||
* A PR should be focused on content. Any PRs where the changes are only syntax will be rejected. | ||
* Use the file you are editing as a style guide. | ||
* Consider your feature. [Suggestion Guidelines](http://ae-mod.info/Suggestion-Guidelines/) | ||
- Is your suggestion already possible using Galacticraft or other Addons? | ||
- Make sure your feature isn't already in the works, or hasn't been rejected previously. | ||
- If your feature can be done by any popular mod, discuss with us first. | ||
|
||
### Getting Started | ||
|
||
1. Fork this repository | ||
2. Clone the fork via | ||
* SSH `git clone git@github.com:<your username>/GalacticTweaks.git` or | ||
* HTTPS `git clone https://github.com/<your username>/GalacticTweaks.git` | ||
3. It is prefered you create a new branch and base it off Dev-1.12.2 (Branches based off the realease branch will be rejected) | ||
4. Run `gradlew setupDecompWorkspace` setup your Development Environment | ||
5. Ensure any changes are tested prior to commiting to your new branch with `gradlew runClient` | ||
- 5a. If adding any dependencies for your changes, these MUST be approved prior to adding | ||
6. Commit changes to your forked repo | ||
7. Publish your new branch to your Github fork | ||
8. Create a Pull-Request on GitHub | ||
9. Wait for review | ||
10. Squash commits for cleaner history | ||
|
||
If you are only doing single file pull requests, GitHub supports using a quick way without the need of cloning your fork. Also read up about [syncing](https://help.github.com/articles/syncing-a-fork) if you plan to contribute on regular basis. | ||
|
||
### English Text | ||
|
||
`en_us.lang` is included in this repository, fixes to typos are welcome. | ||
|
||
### Encoding | ||
|
||
Files must be encoded as UTF-8. |
Oops, something went wrong.