Merge pull request #91 from vb2007/dev-documentation

Merge dev-documentation to Dev

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Discordbot contributing guide
+
+Thank you for investing your time in contributing to this project.
+
+When contributing, please make sure to always follow the project's [CODE OF CONDUCT](./CODE_OF_CONDUCT.md).
+
+This guide will help you get some ground about how contributions work.
+
+## Contributing
+
+### Issues
+
+If you found a bug, or you think the project needs new commands / features, please open an issue on the project's [issues page](https://github.com/vb2007/discordbot/issues/new).
+
+If possible, please go with an issue template.
+
+Before opening an issue, make sure it hasn't been reported already by somebody else. [Project's existing issues.](https://github.com/vb2007/discordbot/issues)
+
+#### Reporting bugs
+
+If you found a bug with the bot, please make sure to explain the issue with as much details as possible, and **attack screenshots / videos**.
+
+### Pull requests
+
+#### Basic steps for newcomers
+
+1. Fork the repository
+2. Clone your fork
+3. Make your changes with relevant commit messages
+4. Push your commits
+5. When you're done, open a Pull Request (PR)
+
+#### Making changes
+
+When making changes to the codebase, please watch out for the following:
+
+- Don't remove code that's essential for the project to work properly
+- Try to write optimal code
+- Make sure the project passes all unit tests after your changes
+
+After you're done, make a Pull Request to the `dev` branch. If possible, please link an issue / issues to your PR.

SECURITY.md

@@ -0,0 +1,20 @@
+# Security Policy
+
+## Supported Versions
+
+Currently, only the latest version of the project gets regular security updates and pathces.
+
+If the latest version has any vulnerability, it is likely going to get patched in the next release.
+
+I don't maintain any version that's not the latest.
+
+| Version  | Supported          |
+| -------- | ------------------ |
+| > latest | :white_check_mark: |
+| < latest | :x:                |
+
+## Reporting a Vulnerability
+
+You can report a vulnerability on the [repository's security page](https://github.com/vb2007/discordbot/security).
+
+When reporting, please explain the with as much details as possible.

commands/administration/autorole-configure.js

@@ -58,15 +58,15 @@ module.exports = {
                         var localEmbedResponse = embedReply(
                             embedColors.successSecondary,
                             "AutoRole Configure: Configuration Modified",
-                            `The role that will get assigned to new members has been **modified** to \`@<${targetRole}>\` :white_check_mark:\nRun this command again to modify the role.\nRun \`/autorole-disable\` to disable this feature.`,
+                            `The role that will get assigned to new members has been **modified** to <@&${targetRole}>. :white_check_mark:\nRun this command again to modify the role.\nRun \`/autorole-disable\` to disable this feature.`,
                             interaction
                         );
                     }
                     else {
                         var localEmbedResponse = embedReply(
                             embedColors.success,
                             "AutoRole Configure: Configuration Set",
-                            `The role that will get assigned to new members has been **set** to \`@<${targetRole}>\` :white_check_mark:\nRun this command again to modify the role.\nRun \`/autorole-disable\` to disable this feature.`,
+                            `The role that will get assigned to new members has been **set** to <@&${targetRole}>. :white_check_mark:\nRun this command again to modify the role.\nRun \`/autorole-disable\` to disable this feature.`,
                             interaction
                         );
                     }

package.json

@@ -16,7 +16,18 @@
     "sql",
     "mariadb"
   ],
-  "author": "vb2007 <admin@vb2007.hu> (https://vb2007.hu)",
+  "author": {
+    "name": "vb2007",
+    "email": "admin@vb2007.hu",
+    "url": "https://vb2007.hu"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vb2007/discordbot.git"
+  },
+  "bugs": {
+    "url" : "https://github.com/vb2007/discordbot/issues"
+  },
   "license": "AGPL-3.0-only",
   "dependencies": {
     "ajv": "^8.17.1",