malouro / ggis-bot Goto Github PK

There are many parts of the source code that are hard to figure out without decent comments or documentation. At the very least, utility functions & methods should have JSDoc comments for what the params are and what the resulting output is. Additionally, certain handlers are missing documentation.

Is your enhancement related to an existing command or feature?
LFG

Describe the solution you'd like
Updating the current list of LFG games to add more modern popular games and (possibly) removing older irrelevant entries.

Additional context

List of some new game candidates:

• Phasmophobia
• Fall Guys
• Call of Duty
• Genshin Impact

Game mode candidates:

• LoL
  • Nexus Blitz, Urf ?
• ??? < need more research >

Feel free to comment below if there is a game that you wish added into the default LFG list

Is your feature request related to an existing command or feature? Please describe.
LFG

Describe the solution you'd like
A way to add additional information to the LFG party request. For example, if it's a lobby for Rocket League, adding a note like "Trying to rank up, but also would be down to play for fun", etc.

Some ways this could look in the command interface:

• via double quotes around the note:

!lfg lol aram "just for fun"

• via other enclosing tags?

!lfg lol aram [just for fun]
!lfg lol aram `this is serious`
!lfg lol aram |I don't really care|

Write out a CONTRIBUTING.md file that explains how to go about providing contributions to ggis-bot

Some things to include within the contribution guidelines are:

• Opening/taking an issue
• Making a PR
• Commit style
  • Squash commit back to master with specific commit style
• Code style
• Merge check requirements
• CHANGELOG or release notes?

Example format:

const configOptions = {
  '<scope>': {
    arrayOption: {
      type: 'array'
    }
  }
}

Optionally, allow to specify the type of elements for the array too:

const configOptions ={
  '<scope>': {
    arrayOption: {
      type: 'array-of-strings'
    }
  }
}

Is your enhancement related to an existing command or feature?
Server/bot settings

Describe the solution you'd like
To allow user input of a #text-channel or @User for a bot/command setting via the !settings command

Additional context
Text channels are seen by the bot as something like: <#TEXT_CHANNEL_ID> and user mentions as <@!USER_ID>, so setting.js should parse these string inputs and perhaps cross-check that they are valid channels/users within the guild the command was invoked in?

Hey mate,

Not sure if you check this anymore as I see that the last time it was updated was 10 months ago, but I've been trying my best to add Platform and Rank to the currently LFG code, could you shed some light on how I can approach this?

TIA

When a LFG is run and a party has been created, if a user reacts to the embed and joins the party, but then removes the reactions, they are not removed from the embed itself.

Let's document stuff in a better place. IE: making a webpage (GitHub Pages?) or a wiki page (GitHub Wiki)

(more details to come)

Is your feature request related to an existing command or feature?
Yes, it's related to the !lfg command.

Describe the solution you'd like
To set an LFG channel for the command to be used in, such as !settings lfg lfgchannel #lfg and another command such as !settings lfg commandonly true to only allow commands in that channel, can be turned off.

Additional context
Spoke to you via Discord about this so a lot of the information is there

Would be great to implement this

Making more tests & hooking it up to CI.

• Code coverage on handlers, commands, etc.
• More End-to-end tests, where it makes sense
• Linting, formatting, spellcheck?
• Git Hooks?

https://discordjs.guide/additional-info/changes-in-v12.html

Originally posted by @malouro in #63 (comment)