Skip to content

Project Guidelines

Jacob Pretorius edited this page Nov 17, 2022 · 3 revisions

Any and all contributions are welcome (and encouraged!).

Please do so using a pull request to the relevant branch (probably off of main, until we have release candidates)

Rules

  1. Don't be creepy. Projects and users are trusting is with sensitive data, so be sure to treat it that way. Don't log user IPs. Don't log user messages or track their exact behaviour. Don't build things which are meant to scan all conversations in Discord and do something creepy with it.
  2. Optional is always better. The variety between projects out there is vast and while most could like a feature we built, forcing them to use it from the start makes the barrier to entry that much higher. It's better for everyone if they can start with a "simple" bot implementation and add features once they know they want to keep the bot around and see it working well.
  3. Please share. Building this all took a significant amount of time and the more people/projects have access to it the better. Please share it around with anyone interested, and if you develop additional features (no matter how well they are done programming wise) please share them back to the project via a pull-request so others can get ideas and perhaps even use your feature - you will be credited!

Naming

Trying to stick to https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines as long as it makes sense for naming. Although rule 2 is to be ignored as IInterface names are preferred.

Clone this wiki locally