docs: Add AI Coding Assistants documentation by Netplayz · Pull Request #217 · mikeywhiston/ERM

Netplayz · 2026-04-09T03:30:57Z

Add guidance for AI assistants and developers using AI tools for ERM
contributions.

documentation/coding-assistants.md is for guiding AI assistants
on licensing, Signed-off-by requirements, and attribution format. The
README.md points AI tools to this documentation so they wont miss it.

Signed,
Netbyte

edit: PR message was taken and edited from torvalds/linux@78d979d

ar-cyber

All good. Just some branding issues.

ar-cyber · 2026-04-09T21:11:42Z

+# AI Coding Assistants
+
+This document provides guidance for AI tools and developers using AI  
+assistance when contributing to the ERM bot.


ar-cyber · 2026-04-09T21:11:50Z

+This document provides guidance for AI tools and developers using AI  
+assistance when contributing to the ERM bot.
+
+AI tools helping with ERM bot development should follow the standard  


same here. Just ERM instead of ERM bot

Netplayz · 2026-04-09T21:14:41Z

Fixed

ar-cyber

Just one grammatical error. Changes look good tho.

Netplayz · 2026-04-09T21:17:42Z

Where's the error

Co-authored-by: Andrew R <25roband@cbc.sa.edu.au>

ar-cyber

All good. Just need unknown to merge (or mikey)

CC: @UnknownGamerz6996 @mikeywhiston

Netplayz · 2026-04-09T21:18:44Z

Found it, I'm not use to the github UI on mobile.

Netplayz · 2026-04-09T21:19:19Z

All good. Just need unknown to merge (or mikey)

CC: @UnknownGamerz6996 @mikeywhiston

👍

ar-cyber · 2026-04-09T21:21:35Z

Found it, I'm not use to the github UI on mobile.

I hate it on my phone. I literally get out my laptop on the bus just to review prs.

Netplayz · 2026-04-09T21:26:19Z

I'm in the car getting pizza and fixing these issues lol

Netplayz · 2026-04-09T21:26:56Z

Expect a few more PRs about documentation on modules

Netplayz · 2026-04-09T21:28:16Z

Unknown complained about undocumented code in VC a while back that's why I thought of it.

…tplayz/ERM/tree/Development

Netplayz · 2026-04-12T04:00:44Z

@UnknownGamerz6996 I have more documentation I need to put in.

Netplayz · 2026-04-12T04:01:08Z

I am gonna put it in a different PR but I cant open a PR until you approve this one.

too difficult to explain

ar-cyber · 2026-04-26T02:29:45Z

Just made some changes to the contribution guidelines as some stuff isn't required.

ar-cyber

just some things to change

ar-cyber · 2026-04-26T02:37:13Z

+  or MongoDB `ObjectId` values depending on the collection.  
+- The `Document` base class in `utils/mongo.py` provides all standard  
+  async CRUD methods. Use those rather than accessing `bot.db` directly  
+  with raw pymongo calls.  


raw pymongo calls are required as the document class doesn't expose everything. e.g. find_one, find, and aggregate may be needed but aren't exposed.

not really necessary to remove.

Netplayz · 2026-04-26T03:01:33Z

@ar-cyber review requested

ar-cyber · 2026-04-26T03:06:37Z

@ar-cyber review requested

No changes have been made.

Co-authored-by: Andrew R <loafing@sockycat.net>

ar-cyber

just these changes

ar-cyber · 2026-04-26T23:18:06Z

+
+When inviting the bot, the following are required:
+
+-  `Bot`


Bot doesn't have a capital B - it's a scope, like applications.commands

it doesnt really matter

ar-cyber · 2026-04-26T23:25:12Z

+- Python 3.12. Match the style of the surrounding code.  
+- All database calls must be `async`. Use `await` throughout — do not  
+  use blocking pymongo calls.
+- Ensure the use of the `Document` class whenever accessing different collections.
+- Do not create Documents in commands, define them on the instance method `self` in the setup hook.
+- Use `discord.ext.tasks.loop` for new background tasks. 
+- New interactive Discord flows must have their own UI file in `ui/`. Do not add new enties to `menus.py`. 
+- Use `utils/constants.py` for shared colour values (`BLANK_COLOR`,  
+  `GREEN_COLOR`, `RED_COLOR`) rather than hardcoding hex values.  
+- Use `decouple.config()` for all environment variable access.
+- Do not use inline ENV comments


ar-cyber · 2026-04-26T23:26:51Z

+| `statistics_check` | Periodic | Updates analytics records |
+| `tempban_checks` | Periodic | Lifts expired temporary bans |
+| `check_whitelisted_car` | Periodic | Enforces whitelisted vehicle rules in-game |
+| `change_status` | Periodic | Rotates the bot's Discord presence status |


ar-cyber · 2026-04-26T23:27:10Z

+| `ERLC` | ER:LC in-game integration (bans, kicks, player lookup) |
+| `GameLogging` | In-game event log forwarding to Discord channels |
+| `Infractions` | Staff infraction tracking and management |
+| `Jishaku` | Developer/debug REPL (conditionally loaded) |


not conditionally loaded

Still needs to be fixed

What do you mean by "not conditionally loaded"

Co-authored-by: Andrew R <loafing@sockycat.net>

Netplayz · 2026-04-26T23:28:59Z

I am on my phone I will do these in a minute

ar-cyber · 2026-04-26T23:29:23Z

I am on my phone I will do these in a minute

all good. no rush

Netplayz · 2026-04-26T23:30:23Z

@ar-cyber can you make edit requests rq since I'm far from my laptop

ar-cyber · 2026-04-27T00:38:02Z

i can't atm

ar-cyber · 2026-05-04T04:29:02Z

@Netplayz can you just finish my feedback

Netplayz · 2026-05-04T11:28:33Z

Hi Andrew, I’m currently focused on a major project that requires my full attention, so I won't be able to address that feedback right now. Best regards, Netbyte

…

On Mon, May 4, 2026 at 12:29 AM Andrew R ***@***.***> wrote: *ar-cyber* left a comment (mikeywhiston/ERM#217) <#217 (comment)> @Netplayz <https://github.com/Netplayz> can you just finish my feedback — Reply to this email directly, view it on GitHub <#217 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AQUG6FRRYKWVRNUS43XESC34ZAMCLAVCNFSM6AAAAACXR5USHWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DGNRYGI2DKOBSGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

ar-cyber · 2026-05-04T21:18:58Z

Hi Andrew, I’m currently focused on a major project that requires my full attention, so I won't be able to address that feedback right now. Best regards, Netbyte
…
On Mon, May 4, 2026 at 12:29 AM Andrew R @.> wrote: ar-cyber left a comment (mikeywhiston/ERM#217) <#217 (comment)> @Netplayz https://github.com/Netplayz can you just finish my feedback — Reply to this email directly, view it on GitHub <#217 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQUG6FRRYKWVRNUS43XESC34ZAMCLAVCNFSM6AAAAACXR5USHWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DGNRYGI2DKOBSGM . You are receiving this because you were mentioned.Message ID: @.>

That's all good.

Removed duplicate warning about not using this file for new views.

Netplayz

requesting review.

ar-cyber

still needs a couple fixes

ar-cyber · 2026-05-13T23:48:36Z

+| `ERLC` | ER:LC in-game integration (bans, kicks, player lookup) |
+| `GameLogging` | In-game event log forwarding to Discord channels |
+| `Infractions` | Staff infraction tracking and management |
+| `Jishaku` | Developer/debug REPL (conditionally loaded) |


Still needs to be fixed

Co-authored-by: Andrew R <loafing@sockycat.net>

ar-cyber · 2026-05-13T23:49:23Z

 - `PRODUCTION_BOT_TOKEN` — Bot token for the production environment  
- `DEVELOPMENT_BOT_TOKEN` — Bot token for the development environment  
+- `DEVELOPMENT_BOT_TOKEN` — Bot token for the development environment
+- `CUSTOM_GUILD_ID` must stay 0 in order to be used in other servers. If set to a specific server the bot cannot operate in other servers.


Must be set to 0 regardless of usage.

Netplayz added 4 commits March 14, 2026 16:22

Delete a duplicate license.

9bfe864

Merge branch 'mikeywhiston:Development' into Development

1425ba7

Create coding-assistants.md

03986c6

Add clarity to assisted AI coding.

d4e47cc

ar-cyber approved these changes Apr 9, 2026

View reviewed changes

Update coding-assistants.md

cbc45b3

ar-cyber approved these changes Apr 9, 2026

View reviewed changes

Comment thread documentation/coding-assistants.md Outdated

Update coding-assistants.md

f5def33

Co-authored-by: Andrew R <25roband@cbc.sa.edu.au>

ar-cyber approved these changes Apr 9, 2026

View reviewed changes

Netplayz added 5 commits April 9, 2026 19:27

Update readme.md

791c355

Documenation updates

f6d8844

Merge tag 'documentation-for-ERM' of git://https//homeserver.local/Ne…

2d19c76

…tplayz/ERM/tree/Development

Update readme.md

573eaac

Update setup.md

7f5fab8

improve the contribution guidelines to tailor more to what ERM needs

0229ef4

too difficult to explain

ar-cyber requested changes Apr 26, 2026

View reviewed changes

ar-cyber added documentation Improvements or additions to documentation Under Review The ERM Team is Reviewing your Pull Request labels Apr 26, 2026

Netplayz requested a review from ar-cyber April 26, 2026 03:01

Netplayz and others added 6 commits April 25, 2026 23:08

Style editing

43d0a49

Co-authored-by: Andrew R <loafing@sockycat.net>

Update documentation/architecture.md to specify

7b1ccae

Co-authored-by: Andrew R <loafing@sockycat.net>

Update documentation/architecture.md

e1ff127

Co-authored-by: Andrew R <loafing@sockycat.net>

Update documentation/architecture.md

27339a1

Co-authored-by: Andrew R <loafing@sockycat.net>

Update setup.md

f81e9cf

Update setup.md

f19fc7a

ar-cyber requested changes Apr 26, 2026

View reviewed changes

Update readme.md

8b9af1f

Co-authored-by: Andrew R <loafing@sockycat.net>

Netplayz added 2 commits May 12, 2026 20:01

Remove duplicate warning in architecture documentation

e8e9b74

Removed duplicate warning about not using this file for new views.

Update setup.md

7dc5fa9

Netplayz commented May 13, 2026

View reviewed changes

Netplayz requested a review from ar-cyber May 13, 2026 00:05

ar-cyber reviewed May 13, 2026

View reviewed changes

Update architecture.md

75ab4c8

Co-authored-by: Andrew R <loafing@sockycat.net>

ar-cyber reviewed May 13, 2026

View reviewed changes

Conversation

Netplayz commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ar-cyber left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

ar-cyber left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

ar-cyber left a comment

Choose a reason for hiding this comment

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

ar-cyber commented Apr 9, 2026

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

Netplayz commented Apr 9, 2026

Uh oh!

Netplayz commented Apr 12, 2026

Uh oh!

Netplayz commented Apr 12, 2026

Uh oh!

ar-cyber commented Apr 26, 2026

Uh oh!

ar-cyber left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Netplayz commented Apr 26, 2026

Uh oh!

ar-cyber commented Apr 26, 2026

Uh oh!

ar-cyber left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Netplayz commented Apr 26, 2026

Uh oh!

ar-cyber commented Apr 26, 2026

Uh oh!

Netplayz commented Apr 9, 2026 •

edited

Loading

ar-cyber left a comment •

edited

Loading