Skip to content

Commit

Permalink
chore: add github file
Browse files Browse the repository at this point in the history
  • Loading branch information
Dun-sin committed Nov 4, 2023
1 parent ab5e621 commit 92579b3
Show file tree
Hide file tree
Showing 14 changed files with 450 additions and 59 deletions.
8 changes: 8 additions & 0 deletions .github/Dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"

open-pull-requests-limit: 1
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: 🐛 Bug
description: Report an issue to help improve the project.
title: "[BUG] <what is the issue>"
labels: ["bug", "hacktoberfest"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the question or issue, also include what you tried and what didn't work
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
validations:
required: false

- type: dropdown
id: browser
attributes:
label: "🥦 Browser"
description: "What browser are you using ?"
options:
- Google Chrome
- Brave
- Microsoft Edge
- Mozilla Firefox
- Safari
- Opera
- Other
validations:
required: true

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"

- type: markdown
attributes:
value: |
Follow me on Twitter [here](https://twitter.com/DunsinWebDev)
Feel free to Join the discord server [here](https://discord.gg/kcFraw3nhz) and check out other cool repositories [here](https://github.com/Dunsin)
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 🙋🏾🙋🏼Question
url: https://discord.gg/ufcysW9q23
about: Feel free to ask your question on our Discord channel.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: 📄 Documentation issue
description: Found an issue in the documentation? You can use this one!
title: "[DOCS] <what do you have to add>"
labels: ["documentation", "hacktoberfest"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the question or issue, also include what you tried and what didn't work
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"

- type: markdown
attributes:
value: |
Follow me on Twitter [here](https://twitter.com/DunsinWebDev)
Feel free to Join the discord server [here](https://discord.gg/kcFraw3nhz) and check out other cool repositories [here](https://github.com/Dunsin)
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/features.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 💡 General Feature Request
description: Have a new idea/feature for this project? Would love to hear it!
title: "[FEATURE] <what do you have to add>"
labels:
[
"feature",
"enhancement",
"hacktoberfest"
]
body:
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the enhancement you propose, also include what you tried and what worked.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this idea?
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"

- type: markdown
attributes:
value: |
Follow me on Twitter [here](https://twitter.com/DunsinWebDev)
Feel free to Join the discord server [here](https://discord.gg/kcFraw3nhz) and check out other cool repositories [here](https://github.com/Dunsin)
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: "[OTHER]"
labels: ["hacktoberfest"]
body:
- type: markdown
attributes:
value: "# Other issue"
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"

- type: markdown
attributes:
value: |
Follow me on Twitter [here](https://twitter.com/DunsinWebDev)
Feel free to Join the discord server [here](https://discord.gg/kcFraw3nhz) and check out other cool repositories [here](https://github.com/Dunsin)
12 changes: 12 additions & 0 deletions .github/config/lock_unlock_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
"🚦 status: awaiting approval":
issues:
comment: >
To reduce notifications, issues are locked until they are valid/approved and to be assigned. In the meantime read the contributing guidelines -> https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md
unlock: true
lock: true

"🏁 status: ready for dev":
issues:
comment: >
The issue has been unlocked and is now ready for dev. If you would like to work on this issue, you can comment to have it assigned to you.
unlock: true
Binary file added .github/docker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Fixes Issue

**My PR closes #issue_number_here**

# 👨‍💻 Changes proposed(What did you do ?)

# ✔️ Check List (Check all the applicable boxes)
<!-- Mark all the applicable boxes. To mark the box as done follow the following conventions -->

<!--
[x] - Correct; marked as done
[X] - Correct; marked as done
[ ] - Not correct; marked as **not** done
-->

- [] My code follows the code style of this project.
- [] This PR does not contain plagiarized content.
- [] The title and description of the PR is clear and explains the approach.

## Note to reviewers

<!-- Add notes to reviewers if applicable -->

# 📷 Screenshots

<!-- Add all the screenshots which support your changes -->
33 changes: 33 additions & 0 deletions .github/workflows/compliance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Compliance

on:
pull_request_target:
types:
- opened
- edited
- synchronize
- reopened
workflow_call:

permissions:
pull-requests: write

jobs:
pr-compliance-checks:
name: PR Compliance Checks
runs-on: ubuntu-latest
steps:
- uses: mtfoley/[email protected]
with:
body-auto-close: false
protected-branch-auto-close: false
watch-files: |
package.json
package-lock.json
body-comment: >
## Issue Reference
In order to be considered for merging, the pull request description must refer to a
specific issue number. This is described in our
[Contributing Guide](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md).
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue
number that this PR is meant to address.
25 changes: 25 additions & 0 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: deploy website
on:
pull_request_target:
branches:
- main
types:
- closed


jobs:
deploy:
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: |
tsc && npm run build
- uses: amondnet/vercel-action@v20 #deploy
with:
vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
github-token: ${{ secrets.GENERAL_TOKEN }} #Optional
vercel-args: '--prod' #Optional
vercel-org-id: ${{ secrets.ORG_ID}} #Required
vercel-project-id: ${{ secrets.PROJECT_ID}} #Required
working-directory: ./client
18 changes: 18 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
on:
fork:
push:
branches: [main]
issues:
types: [opened]
issue_comment:
types: [created]

jobs:
welcome:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: EddieHubCommunity/gh-action-community/src/welcome@main
with:
github-token: ${{ secrets.GITHUB_TOKEN}}
issue-message: '<h1>It''s great having you contribute to this project by creating an issue</h1> Make sure you are assigned to this before you work on it and you read the <a href="https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md">Contributing.md file</a>, Thank you! Welcome to the community :nerd_face:'
18 changes: 18 additions & 0 deletions .github/workflows/unlock-lock-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Lock Issue and Assign Labels

on:
issues:
types: labeled

permissions:
issues: write

jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/label-actions@v3
with:
process-only: issues
config-path: .github/config/lock_unlock_issue.yml
github-token: ${{ secrets.GITHUB_TOKEN }}
Loading

0 comments on commit 92579b3

Please sign in to comment.