Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.72 KB
Raw

Thank you for contributing to screeps-kotlin-types!

This document contains guides on getting started with developing screeps-kotlin-types, as well as the guidelines for contributing to this repository.

This library will stay up to date only with the help of you! If active players don't update it, it'll get lost.

The Five Golden Rules

The simple steps of contributing to any GitHub project are as follows:

  1. Fork the repository
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push -u origin my-new-feature
  5. Create a Pull Request!

To keep your fork of in sync with this repository, follow this guide.

Getting Started

To get started, just clone this repository, and install the required dependencies.

./gradlew build

Testing Locally

Install the library locally

  • Run ./gradlew publishKotlinPublicationToMavenLocal to install the library locally on your machine
  • Add mavenLocal() to the repositories section of your bots build.gradle.kts
  • Change the dependency in your bot to ch.delconte.screeps-kotlin:screeps-kotlin-types:SNAPSHOT

OR

Using https://jitpack.io/

  • Add maven( url="https://jitpack.io") to the repositories section of your bots build.gradle.kts
  • Add the branch or last commit of your PR as a dependency to your bot implementation eg com.github.<github_user>:screeps-kotlin-types:<branch_name>-SNAPSHOT")

Filing Issues

Please feel free to submit issues for bugs and feature requests, I promise to get back to you ASAP!