currently not being worked on as i do not feel up to it, this project is currently frozen
A few useful links:
Sadly there is no stable release that is usable in modpacks yet check back later
Nothing here yet :P
Important
- Make sure you never merge yourself unless really needed
- Merging vs. Rebasing
Nightfall/SRails is the central repository for @Nightfall/contributors Everybody else should fork from master
git config --global --bool pull.rebase true
Important
- Make sure you know how to use rebase correctly
Important
- Make sure you have the Gradle plugin enabled in IntelliJ IDEA (File->Settings->Plugins).
- Make sure you have the Scala plugin enabled.
Clone the repository, then in it run
gradlew setupDecompWorkspace
to setup the workspace, including assets and such, then
gradlew idea
to create an IntelliJ IDEA project.
Open the project and you will be asked to import the Gradle project (check your Event Log if you missed the pop-up). Do so. This will configure additionally referenced libraries.
Use the customizable gradle wrapper if it doesn't work or get stuck or a recent local gradle version (2.9 or 2.10)
In the case you wish to use Eclipse rather than IntelliJ IDEA, the process is mostly the same, except you must run gradlew eclipse rather than gradlew idea.
we have 3 types of branches
| branch | info |
|---|---|
| master | Protected release branch |
| feature/ | Features and wip stuff goes here |
| hotfix/<bug-name or issue #> | Hopefully we will not need those |
before rebasing:
- Squash your commits into logical units!
- rebase changes in master into your branch (instead of merging)
- Make sure you followed the guidelines
The following are a few quick guidelines on pull requests. That is to say they are not necessarily rules, so there may be exceptions and all that. Just try to stick to those points as a baseline.
- Make sure your code is formatted properly.
- Make sure it builds and works.
- Try to keep your changes as minimal as possible. In particular, no whitespace changes in existing files, please.
- Use the Staging Area when committing
- don't mess up :P
create a PR: https://github.com/Nightfall/SRails/compare/feature-name