Skip to content

Commit

Permalink
Repository essentials
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjackyliang committed Dec 29, 2023
1 parent 29faa6b commit da2df24
Show file tree
Hide file tree
Showing 11 changed files with 144 additions and 55 deletions.
1 change: 1 addition & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ indent_style = tab

[{*.markdown,*.md}]
ij_markdown_max_lines_around_block_elements = 0
ij_markdown_max_lines_around_header = 0
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
github: mrjackyliang
custom: "https://liang.nyc/paypal"
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -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
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
blank_issues_enabled: false
blank_issues_enabled: false
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ $RECYCLE.BIN/
#### NodeJS ####
################
node_modules/
build/
package-lock.json
.env
.env.development.local
Expand All @@ -76,3 +75,4 @@ package-lock.json
##########################
#### Project Excludes ####
##########################
build/
16 changes: 8 additions & 8 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
ISC License

Copyright (c) 2019, 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.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
Discord Audio Stream Bot
========================

[![GitHub Releases](https://img.shields.io/github/v/release/mrjackyliang/discord-audio-stream-bot?style=flat-square&color=blue&sort=semver)](https://github.com/mrjackyliang/discord-audio-stream-bot/releases)
[![GitHub Top Languages](https://img.shields.io/github/languages/top/mrjackyliang/discord-audio-stream-bot?style=flat-square&color=success)](https://github.com/mrjackyliang/discord-audio-stream-bot)
[![GitHub License](https://img.shields.io/github/license/mrjackyliang/discord-audio-stream-bot?style=flat-square&color=yellow)](https://github.com/mrjackyliang/discord-audio-stream-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-audio-stream-bot?style=flat-square&logo=github&logoColor=%23ffffff&color=%23b25da6)](https://github.com/mrjackyliang/discord-audio-stream-bot/releases)
[![GitHub Top Languages](https://img.shields.io/github/languages/top/mrjackyliang/discord-audio-stream-bot?style=flat-square&logo=typescript&logoColor=%23ffffff&color=%236688c3)](https://github.com/mrjackyliang/discord-audio-stream-bot)
[![GitHub License](https://img.shields.io/github/license/mrjackyliang/discord-audio-stream-bot?style=flat-square&logo=googledocs&logoColor=%23ffffff&color=%2348a56a)](https://github.com/mrjackyliang/discord-audio-stream-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)

A small utility that captures audio from a local source and broadcasts it to a Discord server. DASBot requires several dependencies and has been developed and tested on macOS.

Expand Down
12 changes: 9 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,16 @@
"type": "git",
"url": "git://github.com/mrjackyliang/discord-audio-stream-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-bot",
Expand Down

0 comments on commit da2df24

Please sign in to comment.