Short Description

Dogo is an Open Source Discord Bot focused on guild administration and utilities.

Useful Links

• Support Guild
• [WIP] Documentation
• [WIP] Wiki

Technologies

• Development Language: Kotlin from JetBrains
• Web Server: kTor from JetBrains
• Discord API: JDA from DV8FromTheWorld
• Dependency Mananger: Gradle from Gradle Inc.
• Personal IDE: Intellij Idea Ultimate from JetBrains (thank you JetBrains for Student Pack)
• License: Apache 2.0
• VCS: Git and GitHub
• SGBD: MySQL from Oracle

Educational

Dogo is being made for didatical purposes, it is helping me to learn a lot about the involved tehcnologies, and I hope it will help you too.

For Devs

Commit Structure

The description of the commits must describe what you did, and should not fix more than one issue per commit; Everything should be written in English (not perfect, but a undersantable one);

ALL METHODS, FUNCTIONS AND CLASSES MUST BE DOCUMENTED ACCORDING TO kDoc.

Excluding overriden methods that its function is already explained on superclass. Anyway you should document it if the method do something that is not described on superclass

Coding Styling

• Braces and Bracksts in the same line. Eg.

  if(...) {
    ...
  }
  

  NOT

  if(...)
  {
    ...
  }
  

• Spacing after and before ``{`` and ``}``. Eg.

  if(...) {
    ...
  }
  
  (...).let { ... }
  

  NOT

  if(...){
    ...
  }
  
  (...).let{...}
  

• Use `it` as possible. Eg.

  (...).also { it.invoke() }
  

  NOT

  (...).also { m -> m.invoke() }
  

• Identation

Copyright

Copyright 2019 Nathan Bombana

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.