botblock / discord-botlist-best-practices

Bot lists must meet these minimum requirements to be considered a bot list.
9 stars 4 forks source link
discord discordapp discordbotlist

Best Practices for Discord Bot Lists


Bot lists must meet these minimum requirements to be considered a bot list.

Your bot list must:

  1. use a custom domain name with a respectable, paid TLD.
  2. not be a [xyz].glitch.me, [xyz].repl.co or any free (sub)domain with free hosting provider.
    • Glitch, Repl, or any other free host is acceptable if:
      • Uptime is immaculate
      • A custom domain name is used (whilst still following point 1)
  3. be fully functioning.
    • No broken links/buttons.
  4. have consistent uptime.
    • Minor downtime for maintenance or fixing issues is fine
  5. have bot listing requirements (such as no NSFW outside NSFW channels, respect rate-limits, don't respond to other bots, etc.)
  6. blur NSFW profile pictures.
  7. have a ToS and Privacy page.

Bot lists should meet these requirements to be a good bot list.

Your bot list should:

  1. not display all bots on the homepage.
  2. not be hosted on any free hosting provider.
  3. be mobile friendly.
  4. not be paid access only.
  5. have an API with good documentation.
    • API should support GETting bot information
      • Sends a JSON body for the response data
    • API should support POSTing bot stats
      • Server/guild count
      • Shard support
      • Uses an Authorization header
      • Accepts a JSON body format for data
  6. respond with correct status codes.
    • All pages that load correctly should respond with a 2xx status code
    • Not found (404) pages should respond with a 404 status code
    • Any API should also send correct status codes
  7. not overuse ads. Ads are okay, but shouldn't influence the browsing experience in a negative way.
  8. have API (and the frontend if possible) ratelimits. (60 requests per minute recommended)
  9. have a way for users to contact the folks operating the site (email, Discord, etc.).
  10. notify users beforehand when your TOS or privacy policy is changing.
  11. not be a copy of other's bot lists (open sourced lists, including lists that are edited or modified from other's lists).

If anyone wants to change or add something, please make a pull request.

Inspired by Discord Bot Best Practices