Skip to content
This repository has been archived by the owner on Nov 13, 2022. It is now read-only.

Latest commit

 

History

History
25 lines (14 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

25 lines (14 loc) · 1.3 KB
Raw

Contributing to Leikr

Leikr is not only intended to be a welcome platform for those creating games, it's a welcome platform for those willing to improve Leikr as a game creation tool.

Leikr is written in Java and uses Gradle to build.

Building Leikr

Clone the repository to your local machine. In the Leikr folder, run gradlew launchDesktop to build and launch Leikr.

Contributing Code

To submit code to the Leikr repository, simply do the following:

  1. Fork the Leikr repository using the Fork button on the main repository.

  2. Clone your forked repository to your local machine. Create a new branch (do not use master) for your intended changes. Please try to be descriptive as to the branch contents, and try to limit the scope of a single branch.

  3. Optionally, feel free to add your name to the AUTHORS file.

  4. Commit your changes and push the branch to Github.

  5. Github will show a button in your repository to compare your branch changes to the main repository and create a Pull Request. Click the button and fill out the PR description field, then submit your Pull Request for approval. PRs are generally approved within a day or so.

Issues or Requests

Use the Github Issues page to create either bugs or feature requests.