From 66b02f2e66fc80c46c6751de1e13313344b6925b Mon Sep 17 00:00:00 2001 From: Jacky Liang Date: Thu, 28 Dec 2023 21:15:43 -0500 Subject: [PATCH] Repository essentials --- .editorconfig | 1 + .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 50 ++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 21 ------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 17 ------ .gitignore | 2 +- LICENSE | 16 ++--- README.md | 9 +-- package.json | 16 +++-- 11 files changed, 146 insertions(+), 57 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.editorconfig b/.editorconfig index 64aa029..f5164ce 100644 --- a/.editorconfig +++ b/.editorconfig @@ -51,3 +51,4 @@ indent_style = tab [{*.markdown,*.md}] ij_markdown_max_lines_around_block_elements = 0 +ij_markdown_max_lines_around_header = 0 diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 43220a9..b35dcfe 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1,2 @@ github: mrjackyliang +custom: "https://liang.nyc/paypal" diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 0000000..b7a7d23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,68 @@ +name: Bug Report +description: Found an unexpected issue or problem? Report it here. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: I truly appreciate you taking the time to share this bug report with me. + - type: markdown + attributes: + value: Please __fill out the form with as much detail as possible__ so the contributors can easily recreate the bug and work swiftly to assist you in resolving it. Thank you for your cooperation! + - type: markdown + attributes: + value: --- + - type: checkboxes + id: pre-check + attributes: + label: Pre-check confirmation + description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for contributors to effectively identify and address the bug. __All boxes MUST be checked; failure to comply will result in the immediate closure of this bug report.__ + options: + - label: I have provided a descriptive title for the bug I am having + required: true + - label: "I have kept the original title prefix, __\"[Bug]: \"__" + required: true + - label: I have done my research, and this is __NOT__ a duplicate bug report + required: true + - label: I am __NOT__ requesting a new feature + required: true + - type: input + id: email + attributes: + label: Your email address + description: Help the contributors easily get in touch with you if they need more information. __If possible, please consider using an alias you have access to as this information is publicly visible.__ + placeholder: e.g. user@example.com + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: Tell us exactly what happened + description: Provide a comprehensive description of __the steps or circumstances__ that led to the occurrence of this bug. + placeholder: e.g. When I was doing ..., I expected ... to happen, but I got ... instead. + validations: + required: true + - type: input + id: node-version + attributes: + label: Node.js® version + description: What version of Node.js® are you using? __Using a version with the latest features may not be supported.__ It is recommended that you use versions that are "Recommended for Most Users" or under "Long Term Support (LTS)" as listed in the [Node.js®](https://nodejs.org) homepage. + placeholder: e.g. 20.10.0 + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs relevant to this bug + description: Copy and paste all logs related to this bug. __Do not include logs unrelated to this project.__ This block will be automatically formatted into code, so __no need for backticks__ or special markup. + render: Shell + validations: + required: true + - type: checkboxes + id: legal + attributes: + label: Legal Agreements + description: By submitting a new bug report, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with us. + options: + - label: I agree to the Terms of Use and Privacy Policy + required: true diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 0000000..264c7a5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Have a new feature in mind? Share your request with me. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: Thank you for contributing to the improvement of this project by submitting a feature request! + - type: markdown + attributes: + value: Please __fill out the form with as much detail as possible__ to help the contributors understand your feature request better. Your input is valuable in shaping the future of this project. + - type: markdown + attributes: + value: --- + - type: checkboxes + id: pre-check + attributes: + label: Pre-check confirmation + description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for the consideration of your request. __All boxes MUST be checked; failure to comply may result in your request being closed.__ + options: + - label: I have provided a descriptive title for my feature request + required: true + - label: "I have kept the original title prefix, __\"[Feature]: \"__" + required: true + - label: I have confirmed that this feature is __NOT__ already present or planned + required: true + - type: input + id: email + attributes: + label: Your email address + description: Help the contributors easily get in touch with you if they need more information. __If possible, please consider using an alias you have access to as this information is publicly visible.__ + placeholder: e.g. user@example.com + validations: + required: true + - type: textarea + id: feature-description + attributes: + label: Describe the new feature requested + description: Provide a detailed description of the feature you would like to see implemented. Include any relevant information or use cases that might help the contributors understand the need for this feature. + placeholder: e.g. I would like a new feature that allows... + validations: + required: true + - type: checkboxes + id: legal + attributes: + label: Legal Agreements + description: By submitting a new feature request, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with us. + options: + - label: I agree to the Terms of Use and Privacy Policy + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 95d1716..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Bug report -about: Found an issue? Report the problem here. -title: 'DESCRIBE THE BUG HERE AS SYSTEMATICALLY AS POSSIBLE' -labels: 'bug' -assignees: '' - ---- -### Describe the bug: -What do you think the problem relates to? - -### Steps to reproduce the bug: -1. - -### Expected behavior: -A clear and concise description of what you expected to happen. - -### Logs related to this bug: -```sh -SAMPLE TEXT -``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ec4bb38..3ba13e0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false \ No newline at end of file +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index caecfbf..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Have an idea? Suggest it here. -title: 'DESCRIBE YOUR REQUEST HERE AS SYSTEMATICALLY AS POSSIBLE' -labels: 'enhancement' -assignees: '' - ---- - -### Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. For example, I'm always frustrated when [...] - -### Describe the solution you'd like: -A clear and concise description of what you want to happen. - -### Describe alternatives you've considered: -A clear and concise description of any alternative solutions or features you've considered. diff --git a/.gitignore b/.gitignore index b52d414..b78f277 100644 --- a/.gitignore +++ b/.gitignore @@ -49,7 +49,6 @@ $RECYCLE.BIN/ #### NodeJS #### ################ node_modules/ -build/ package-lock.json .env .env.development.local @@ -76,5 +75,6 @@ package-lock.json ########################## #### Project Excludes #### ########################## +build/ config.json invites.ejs diff --git a/LICENSE b/LICENSE index b54a652..89daf37 100644 --- a/LICENSE +++ b/LICENSE @@ -1,15 +1,15 @@ ISC License -Copyright (c) 2021, Jacky Liang +Copyright (c) 2023, Jacky Liang Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index c51af25..f1e11ea 100755 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ Discord Stonker Bot ==================== -[![GitHub Releases](https://img.shields.io/github/v/release/mrjackyliang/discord-stonker-bot?style=flat-square&color=blue&sort=semver)](https://github.com/mrjackyliang/discord-stonker-bot/releases) -[![GitHub Top Languages](https://img.shields.io/github/languages/top/mrjackyliang/discord-stonker-bot?style=flat-square&color=success)](https://github.com/mrjackyliang/discord-stonker-bot) -[![GitHub License](https://img.shields.io/github/license/mrjackyliang/discord-stonker-bot?style=flat-square&color=yellow)](https://github.com/mrjackyliang/discord-stonker-bot/blob/master/LICENSE) -[![Become a GitHub Sponsor](https://img.shields.io/badge/sponsor-github-black?style=flat-square&color=orange)](https://github.com/sponsors/mrjackyliang) +[![GitHub Releases](https://img.shields.io/github/v/release/mrjackyliang/discord-stonker-bot?style=flat-square&logo=github&logoColor=%23ffffff&color=%23b25da6)](https://github.com/mrjackyliang/discord-stonker-bot/releases) +[![GitHub Top Languages](https://img.shields.io/github/languages/top/mrjackyliang/discord-stonker-bot?style=flat-square&logo=typescript&logoColor=%23ffffff&color=%236688c3)](https://github.com/mrjackyliang/discord-stonker-bot) +[![GitHub License](https://img.shields.io/github/license/mrjackyliang/discord-stonker-bot?style=flat-square&logo=googledocs&logoColor=%23ffffff&color=%2348a56a)](https://github.com/mrjackyliang/discord-stonker-bot/blob/main/LICENSE) +[![Become a GitHub Sponsor](https://img.shields.io/badge/github-sponsor-gray?style=flat-square&logo=githubsponsors&logoColor=%23ffffff&color=%23eaaf41)](https://github.com/sponsors/mrjackyliang) +[![Donate via PayPal](https://img.shields.io/badge/paypal-donate-gray?style=flat-square&logo=paypal&logoColor=%23ffffff&color=%23ce4a4a)](https://liang.nyc/paypal) An advanced business-ready bot built for finance-related Discord servers. This bot adds a suite of features designed to enhance the experience of your server such as content organization, impersonator detection, bumping threads, and more. diff --git a/package.json b/package.json index 1af68cc..1e54ca5 100755 --- a/package.json +++ b/package.json @@ -16,10 +16,16 @@ "type": "git", "url": "git://github.com/mrjackyliang/discord-stonker-bot.git" }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/mrjackyliang" - }, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/mrjackyliang" + }, + { + "type": "custom", + "url": "https://liang.nyc/paypal" + } + ], "keywords": [ "discord", "discord-bots", @@ -48,7 +54,7 @@ "url": "https://github.com/mrjackyliang/discord-stonker-bot/issues" }, "files": [], - "homepage": "https://github.com/mrjackyliang/discord-stonker-bot#readme", + "homepage": "https://github.com/mrjackyliang/discord-stonker-bot", "engines": { "node": "^18.12.1" },