Lahuca-Software-Development / Lahuca-Software-Development/BotSentry

Grammar corrections for the Discord Bot's entry embed (BotSentry Public)

Open
#73 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
6
Forks
1
PR merge metrics
No merged PRs in 30d

Description

I'd first like to start by saying this grammatical pick-apart is in no way intended to be demeaning in any conceivable way but rather as a suggestion of sorts to correct the grammar mistakes in this embed the bot sends you when you first add it. Now that I've stated I'm totally not a grammar Nazi, let's begin! :D

<@173813978475134977>

Thanks for adding our bot to your server! Only you will be able to see this channel, so you can configure the bot here!

  1. It does not @ mention the guild owner because it's trying to do that from the body title of an embed, which doesn't work. Move that to the main message body and it will ping, as putting it inside the embed itself will not give a notification.
  2. "configure" is more standard English for "configurate", "bot" is not a name, person, or place, so it does not need capitalization on its first letter.

Here are the steps you'll need in order to configure it:

  1. Just a simple reformat of the same thing that rolls better off the tongue because English is painfully flexible :>

Step 1:
Go to your Minecraft server and add an API password.
You can do that by typing /bs apipassword (Desired password)

  1. "Minecraft" has a capitalized M because it's a "name" (or rather, a "title")
  2. "API" would be better in caps as it's an abbreviation
  3. Putting the `` on either side of the command helps communicate it's a command to separate it from the rest of the message
  4. Capitalizing the D because technically it's the start of a sentence? Idk, it just looks a tiny bit better

Step 2:
After doing Step 1, the server will tell you an IP:PORT.
You must then type here in your Discord server: -configure (IP:PORT) (API Password)

  1. "After doing" is better than "When you did", as it implies to the reader that they've already done Step 1, in order to move onto Step 2. "The" also had incorrect usage here.
  2. "Step 1" should be emphasized a little bit with italics to make it stand apart
  3. "IP:PORT" with `` on either side to emphasize its relation to the command the user just performed
  4. We split into a new line for the second part
  5. After the comma prior to this, a . will work here. We remove "then you have to" and replace it with "You must then", as it further communicates that afterwards kind of feeling.
  6. Putting the command in `` :>
  7. Switching from using { } to ( ) seems a little better for an example to do a command
  8. If you want to a get a little technical with this, [ ] can mean it's required and { } can mean it's optional, but that'd have to be stated in the footer or the bottom of the embed to make it clear - ( ) just works best, here.
  9. "API PASSWORD" to "API Password" so it's a little more clear and better formatted

Step 3:
You're all done! The bot will create a text channel where it will tell you when your server is under a bot attack.
You can move, edit, or rename the channel if you'd like. If you delete it by mistake, you can re-create it with the -configure command in Step 2.

  1. "Congrats" being abbreviated is a bit informal, it'd be better to swap this for "You're all done!", as it communicates "Oh hey, that didn't take long at all!" for the user.
    "you will be already setted up" made me die inside a little, but English can be a rather complicated language for folks who are learning it for their 2nd or 3rd language, so I hope this issue report helped show the more nuanced side of this complicated, beautiful, flexible, and sometimes completely annoying language :>
  2. Listing what the user is able to do with a series of commas is the proper way of doing this, generally you don't want to have more than one "and" in the same sentence. Ending this sentence in a period, because it's after a series of commas.
  3. Using `` for a command as usual, but also recalling Step 2 in italics to remind the user of where they can find the instructions for this again if ever they forget.

BotSentry - Copyright © 2022 Cyber Development

  1. Better formatting for the copyright in the footer

I promise this was completely out of kind nature and not at all intended to make fun of W.I.P English, people who do that are honestly really stupid - All ya need sometimes is to understand a better way of saying something, and what was incorrect about how you were trying to say it. :>

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is named; first locate the code that builds the bot's initial entry embed and message. Apply the requested grammar, formatting, and mention-placement corrections, then verify the resulting embed and setup instructions match the issue.

Written by the indexing model from the issue text.

Assessment

Domain
content
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.