Description
This is an open source Discord bot mainly developed by Lazy Bytez. If you want to take part in the development of the bot please check out the Contributing section.
Open source doesn’t mean everyone can do whatever they want with the bot so there is a strict LICENSE we want you to respect.
Getting started
Requirements
- Go 1.18
- Git
Create .env
cp .env.example .env
If you want to test, always insert the Token of your TestBot in the .env
, because this file won’t be committed to git.
Install dependencies
go get
Compile and run (for development usage)
go run .
Build binary (for production usage)
go build .
Contributing
If you want to take part in contribution, like fixing issues and contributing directly to the code base, please visit the How to Contribute document.
Commit messages
Construct of a commit message:
prefix(scope): commit subject with max 50 chars
Example commit message:
feat(comp): add ping slash command
Scopes
Project specific scopes and what to use them for.
'deps', // Changes done on anything dependency related
'devops', // Changes done on technical processes
'api', // Changes in /api/ directory
'comp', // Changes in /component/ directory
'int', // Changes in /internal/ directory
'core' // Changes on files in project root
Prefixes:
Also see CONTRIBUTING.md#commits
'feat', // Some new feature that has been added
'fix', // Some fixes to an existing feature
'build', // Some change on how the project is built
'chore', // Some change that just has to be done (like updating dependencies)
'ci', // Some changes to the continues integration workflows
'docs', // Some changes to documentation located in the repo (either markdown files or code DocBlocks)
'perf', // Some performance improvements
'refactor', // Some code changes, that neither adds functionality or fixes a bug
'revert', // Some changes that revert already done changes
'style', // Some fixes regarding code style
'test', // Some automated tests that have been added
Recommended IDEs
- GoLand (paid)
- Visual Studio Code (free) with Go Language Extension (free)
Useful links
License – Contributing – Code of conduct – Issues – Pull requests