srtigers98 / ye-ol-birthday-reminder

Discord bot to congratulate server members on their birthday.

Birthday Discord Bot

A Discord Bot that saves the birthdays of guild members and congratulates them on their birthday. In this way, each guild member is reminded of the birthdays of the others.

Note: If someone does not want to save their birthday, they do not have to!

ye-ol-birthday-reminder's Issues

Garbage Collection for unused Guilds

• When Bot leaves channel, internal data for this channel hast to be removed from the database
• Scheduler Tasks must be stopped

Add logging

When commands are executed, birthdays updated or when the scheduler sends notifications, no log entries are currently generated.
Thus, an enhancement would be to add detailed logging.

Create a discord thread when sending out a reminder

When a reminder is sent out, the bot should automatically create a thread so that anyone can congratulate without spamming the main channel.

The thread should stay open for 24h or more.

Publish releases to Docker Hub

If a release is made, the built docker image should be pushed to docker hub to make the image publicly available.

Create a /version command to see what version or git commit the bot is currently running

Add a simple /version command to get the git commit or milestone the bot is running.
This is useful for CI deployments to see if that actually works.

Ask for upcoming birthday

Implement a command that enables a user to get Information which birthday of which user is coming up

Configurable reminder time

Currently, it is always checked at 12pm of the local server time whether someone has a birthday on today's day.
Thus, reminders can come very early or late if a user has a different time zone than the server.

To make the reminder time flexible, the cron string should be configurable.

Default Cron: 0 0 12 * * *

Generate calendar entry

• Clander Entries for Outlook / Google Calendar etc.

Run only unit tests on default

To avoid the need of a discord bot token, which must be provided to run the integration tests, to run the gradle test goal, only the unit tests should be executed by default.
The execution of the integration tests should be either indicated by an environment variable or by running a separate gradle goal.

Help command

Is your feature request related to a problem? Please describe.
There is no help command present.

Describe the solution you'd like
Implement a help command which shows the user the link to the user documentation.

Additional context
Must be done after:

• #9

Create user documentation

Is your feature request related to a problem? Please describe.
An user can't currently read how to use the discord bot.

Describe the solution you'd like
An user documentation should be created which helps users to install the bot in their guilds and how to use them.
Additionally their should be a documentation which explains how to use the bot self-hosted.

Additional context
The user documentation should either be placed in the repository wiki or on in a github pages website.

Add missing community standards

Is your feature request related to a problem? Please describe.
The repository does not fulfill all recommended GitHub community standards.

Describe the solution you'd like
The repository should meet the GitHub community standards.

TODO

• Code of conduct
• Contributing
• Pull request template