Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.77 KB
Raw

How to build

Clone this repo:

$ git clone https://github.com/ice1000/dev-kt.git

Then:

  • (Optional) Download and decompress Sarasa Gothic font to res/font
  • (Optional) Run gradlew :swing:downloadFiraCode
    • If you don't do this, the editor font will be extremely ugly
  • Use gradlew :swing:fatJar to build this application
  • Run this application with java -jar swing/build/libs/devkt-[some unimportant text]-all.jar

BTW if you don't need the "run" function of DevKt, you can simply run this application by gradlew :swing:run.

Contributing guidelines

You must

  1. Use as much @NotNull and @Nullable as you can in Java codes except local variables

You must not

  1. Break the code style -- use tab indents with spaces aligns
  2. Open pull requests just to fix code style, or use some syntax sugar (DevKt is not SharpLang!)
  3. Add any kind of generated file into the git repo (including the parser!)
  4. Violate the open source license

You should

  1. Use Kotlin except UI, but if you only know Java, never mind, we can help you convert
  2. Name your files like xxx-xxx.kt
  3. Put all highly related classes into a single file
  4. Use English, but we also read Chinese so if you only know Chinese just use it
  5. Write commit message starting with [ issue id or refactor type ]

You'd better

  1. Read http://www.jetbrains.org/display/IJOS/IntelliJ+Coding+Guidelines

You don't have to

  1. Write comments, except you're using magics. Tell us if you do so
  2. Write tests, because we'll review your codes carefully