-
Notifications
You must be signed in to change notification settings - Fork 6
Home
It is currently aimed at new developers wanting to contribute, not users of the bot! It might not contain detailed information on how to use the bot, much rather on how to implement planned features. This might change in the future!
First of all, thanks for wanting to help! Here's a useful tutorial for you if you never contributed to on open-source project: https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/
To understand how the code architecture is structured, I've written a short summary in the following chapter. If you have any questions, contact us on Discord: discord.gg/WUnPvGM
IPat#0001
Heron#5114
For the project, we are using Kotlin (contributions in Java are allowed, though they will be converted to Kotlin some time later by someone else) and Gradle for dependencies.
We are using Gradle modules to categorize features. To find out more about a single module, you can read the README file every feature-relevant module contains. Usually, it'll contain planned features and their detailed description, which are commands or event listeners. If you want to discuss the description of a feature or suggest a new feature altogether, you can do so on the DoD discord server.
That's it! If you're still not sure whether you understand the architecture, check out this little "test" (Currently only available for the develop branch):
- Find the help commands README description SOLUTION
- Find the Kotlin file defining the ban command SOLUTION
Hopefully it made you understand the general architecture of the repository a little better. If you're interested in how exactly the bot works, we recommend to pull the repository and reverse-engineer the code from the commands on out, specifically the core module might interest you.
This wiki contains features in an uncategorized manner (and also less detailed), so if you search for features on the TODO list, here's the place to look around at!