Manage and automate tasks in your discord server with our app :
To invite the discord bot to your server, follow this link, choose your server in the drop down menu, and press the validation button. You can then choose the bot permissions - if you want to change them - before clicking authorize.
the following make commands are available :
| command | description |
|---|---|
| make start | start the project with docker compose |
| make stop | stop the project |
| make log | follow log output |
| make init | same as start, but also copy files |
| make copy-files | copy env files to the right directories, concat global env to other env files |
Please refer to the wiki for more informations.
Once the bot is in the discord server, you can address a message to the bot by beginning your message with assistant
Login command
assistant login
You will receive a message containing a link to the front-end interface, allowing you to manage your server.
Help command
assistant help
You will receive a message containing instructions for all bot commands.
Welcome message command
assistant set-welcome_message <string>
Change the welcome message sent to every new user of the guild.
Birthday command
assistant set-birthday <date>
Tell the bot when is your birthday, in order for it to tell you a happy birthday!
We follow a code of conduct, if you wish to contribute on this project, we strongly advise you to read it.
Branch naming convention
-
You branch should have a name that reflects it's purpose.
-
It should use the same guidelines as COMMIT_CONVENTIONS (
feat,fix,build,perf,docs), followed by an underscore (_) and a very quick summary of the subject in [kebab case][1].Example:
feat_add-image-tag-database-relation.
Pull requests and commits
Pull requests in this project follow two conventions, you will need to use the templates available in the ISSUE_TEMPLATE folder :
- Adding a new feature should use the FEATURE_REQUEST template.
- Reporting a bug should use the BUG_REPORT template.
If your pull request is still work in progress, please add "WIP: " (Work In Progress) in front of the title, therefor you inform the maintainers that your work is not done, and we can't merge it.
The naming of the PR should follow the same rules as the COMMIT_CONVENTIONS
A CI pipeline is configured for this project and is accessible in the Go-CI file.
The pipeline will run 4 different jobs:
- Dependencies check
- Linter
- Build
- Tests
The pipeline will be triggered automatically when creating a new Pull Request and on each push on it. It will also be triggered on push on main branch.
Jason Gauvin |
Jacques Maarek |
Edwin Vautier |
Alexandre Lellouche |