Skip to content

Files

Latest commit

 

History

History
23 lines (17 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 1.27 KB

Contribute, and help us improve

We work out of a discord server, feel free to come join us!

Help improve Elytra!

Thanks for your interest in the project! Pull Requests welcome for any level of improvement, from a small typo to a new feature, help us make the project better.

Committing to an Elytra repo

We use this commit convetion and a this branch flow, at the end of the day we want a clean commit history, so it would be advisable to respect that.

Know-hows

Create a fork

In order to send pull requests (PRs), at the top of the project name on the left side you will have the button below described:


Click on the fork icon and you are **ready to go!**
Compile the project

Elytra is written in Kotlin and utilizes Gradle 2 as build management tool. To compile it from the source, perform the following steps:

  1. Make sure to have Git and Gradle 2 installed
  2. Clone the repository with git clone <fork url here>
  3. Build the project with gradle clean shadowJar build