markuskgit / monkeybot Goto Github PK

In several places we are relying on Newtonsoft.Json. Net core 3 provides a built-in API for the same tasks so port the code to use that instead.
To get started:

• https://devblogs.microsoft.com/dotnet/try-the-new-system-text-json-apis/
• https://github.com/dotnet/corefx/blob/master/src/System.Text.Json/docs/SerializerProgrammingModel.md

DSharp+ seems to be more actively maintained and it also offers some interesting functionality like first class Interactivity

In the latest version of NLog the initialization with loggerFactory.AddNLog is obsolete.
We need to figure out what is the prefered new way of setting up NLog with DI.
The fix needs to be done in Initializer.cs

At the moment the feature to track gameservers isn't working after all the recent upgrades. In fact the commands to add/remove game servers somehow got deleted on the way.

Restore the functionality and test with multiple different servers

EF Core 3.0 has a breaking change that throws a runtime exception when a query can not be evaluated on the server. One has to explicitly switch to client evaluation in this case
For example !benzen is currently broken
See https://docs.microsoft.com/en-gb/ef/core/what-is-new/ef-core-3.0/ for more info

Consider using the new nullable reference types features for more runtime robustness.
To get started:

• https://devblogs.microsoft.com/dotnet/try-out-nullable-reference-types/
• https://docs.microsoft.com/en-us/dotnet/csharp/nullable-references

Trivia has been untouched and untested for too long.

First it needs to be upgraded to using buttons instead of reactions. Second it need thourough testing to make sure it still works.

For our community we need to handle applicants in a smarter way. A couple of commands that handle applications should be created:

The main one is obviously !apply after which the applicant should answer a series of questions that can be configured by the guild admins in seperate commands (something like !addquestion and !removequestion). The applicant should also receive a temporary applicant role. Guild admins can then use !accept *user* or !deny *user*.
It could also be considered to make a thread in an applicant channel per application.

Example workflow:

1. Admins set up questions, application channel and applicant role and member role
2. Applicant uses the apply command. After they answer the questions they get the applicant role and possibly a thread in an applicant channel is created for them, where the answer to the questions is presented
3. Application can be discussed by the community members and then either denied or accepted. If accepted the user gets the member role. In any case the applicant role is removed

The applications and application configurations should be stored in two new Database tables.

The readme should probably highlight some functions of the Bot that stand out, for example the feed and game server updates. It should include a short description and a screenshot

Currently the code is completely uncovered by tests. Figure out what parts of the code can be tested easily and which require more work.
For a start the services that don't depend on Discord should be tested. Try to find good examples how to test the stuff that is more tightly coupled to Discord like command handling.

Add a nicely formatted message for any new guild the Bot joins. It should contain some instructions for first use, a link to the Documentation and the help Discord Guild

The announcements reminders module is another candidate that new some overhauling.
Consider renaming it to Reminder (done), get rid of the command group (make the commands individual, e.g. !setreminder) and possibly make it easier to use with the help of interactivity. Also use the new time formatting option of Discord

Enhance the poll feature by using actual buttons instead of reactions

Currently we are creating new HttpClient instances for various API requests in different services.
As per https://aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong/ this is not the right way There are two options:

1. one global static instance of HttpClient
2. Use HttpClientFactory that was introduced in Net Core 2.1 see

• https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests
• https://docs.microsoft.com/en-us/aspnet/core/fundamentals/http-requests?view=aspnetcore-3.0#basic-usage

I prefer the 2nd option

Consolidate the existing self role management methods by using the new Buttons/Drop Down feature

!addrole should present a drop down of roles you can assign to yourself. Upon clicking one item the user should get that role. On the other hand !removerole should present a dropdown list of roles the user already has. Upon click the role should get removed from the user.

Similarly an admin can add a role dropdown to any message, e.g. on the welcome page (like the current role "buttons"). So users can pick roles at any time without having to use the !addrole command first.

At the moment the permissions for the commands (both by the Bot and the user) are not consistent.

Go over every command and apply the correct needed permissions for both the Bot and the User.

From AppVeyor log:
C:\projects\monkeybot\MonkeyBot\MonkeyBot.csproj.metaproj : warning MSB4078: The project file "MonkeyBot\MonkeyBot.csproj" is not supported by MSBuild and cannot be built
So AppVeyor never actually verifies the build is okay

Find out why it is not working and consider switching CI provider

Is your feature request related to a problem? Please describe.
Using a propper Git-Flow

Describe the solution you'd like
Having a development branch and different feature branches (which will then be merged into the dev branch once completed)

https://datasift.github.io/gitflow/IntroducingGitFlow.html