Skip to content

Commit 76780b4

Browse files
KendallDoesCodingKendallDoesCoding
committed
docs: add the .github directory back
bymistake #29 removed the github directory. This commit adds it back.
1 parent fbad4be commit 76780b4

File tree

10 files changed

+346
-0
lines changed

10 files changed

+346
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: 🐛 Bug
2+
description: Report an issue to help improve the project.
3+
labels: ['🛠 goal: fix']
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A brief description of the question or issue, also include what you tried and what didn't work
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: screenshots
14+
attributes:
15+
label: Screenshots
16+
description: Please add screenshots if applicable
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: extrainfo
21+
attributes:
22+
label: Additional information
23+
description: Is there anything else we should know about this bug?
24+
validations:
25+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/doc.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 📄 Documentation issue
2+
description: Found an issue in the documentation? You can use this one!
3+
title: '[DOCS] <description>'
4+
labels: ['📄 aspect: text']
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: A brief description of the question or issue, also include what you tried and what didn't work
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: screenshots
15+
attributes:
16+
label: Screenshots
17+
description: Please add screenshots if applicable
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: extrainfo
22+
attributes:
23+
label: Additional information
24+
description: Is there anything else we should know about this issue?
25+
validations:
26+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 💡 General Feature Request
2+
description: Have a new idea/feature for quiz? Please suggest!
3+
title: '[FEATURE] <description>'
4+
labels: ['⭐ goal: addition']
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: A brief description of the enhancement you propose, also include what you tried and what worked.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: screenshots
15+
attributes:
16+
label: Screenshots
17+
description: Please add screenshots if applicable
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: extrainfo
22+
attributes:
23+
label: Additional information
24+
description: Is there anything else we should know about this idea?
25+
validations:
26+
required: false

‎.github/ISSUE_TEMPLATE/other.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Other
2+
description: Use this for any other issues. Please do NOT create blank issues
3+
title: '[OTHER]'
4+
labels: ['🚦 status: awaiting triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: '# Other issue'
9+
- type: textarea
10+
id: issuedescription
11+
attributes:
12+
label: What would you like to share?
13+
description: Provide a clear and concise explanation of your issue.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: extrainfo
18+
attributes:
19+
label: Additional information
20+
description: Is there anything else we should know about this issue?
21+
validations:
22+
required: false

‎.github/SECURITY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
Email me at - [email protected], copying [email protected] or fill in this contact form at https://kendalldoescoding.gq/contact to report a Security Issue

‎.github/pull_request_template.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Related Issue/Addition to code
2+
3+
- Issue goes here
4+
5+
## Type of change
6+
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] This change requires a documentation update
13+
14+
# Proposed Changes
15+
16+
- change 1
17+
- change 2
18+
19+
# Additional Info
20+
21+
- any additional info for context
22+
23+
## Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project and have read CONTRIBUTING.md
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules
33+
- [ ] I have checked my code and corrected any misspellings
34+
35+
# Screenshots
36+
37+
| Original | Updated |
38+
| :----------------------: | :----------------------: |
39+
| \*\* original screenshot | ** updated screenshot ** |

‎.github/workflows/codeql-analysis.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL"
13+
14+
on:
15+
push:
16+
branches: [main]
17+
pull_request:
18+
# The branches below must be a subset of the branches above
19+
branches: [main]
20+
schedule:
21+
- cron: "37 4 * * 6"
22+
23+
jobs:
24+
analyze:
25+
name: Analyze
26+
runs-on: ubuntu-latest
27+
permissions:
28+
actions: read
29+
contents: read
30+
security-events: write
31+
32+
strategy:
33+
fail-fast: false
34+
matrix:
35+
language: ["javascript"]
36+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37+
# Learn more about CodeQL language support at https://git.io/codeql-language-support
38+
39+
steps:
40+
- name: Checkout repository
41+
uses: actions/checkout@v2
42+
43+
# Initializes the CodeQL tools for scanning.
44+
- name: Initialize CodeQL
45+
uses: github/codeql-action/init@v1
46+
with:
47+
languages: ${{ matrix.language }}
48+
# If you wish to specify custom queries, you can do so here or in a config file.
49+
# By default, queries listed here will override any specified in a config file.
50+
# Prefix the list here with "+" to use these queries and those in the config file.
51+
# queries: ./path/to/local/query, your-org/your-repo/queries@main
52+
53+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
54+
# If this step fails, then you should remove it and run the build manually (see below)
55+
- name: Autobuild
56+
uses: github/codeql-action/autobuild@v1
57+
58+
# ℹ️ Command-line programs to run using the OS shell.
59+
# 📚 https://git.io/JvXDl
60+
61+
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
62+
# and modify them (or add more) to build your code if your project
63+
# uses a compiled language
64+
65+
#- run: |
66+
# make bootstrap
67+
# make release
68+
69+
- name: Perform CodeQL Analysis
70+
uses: github/codeql-action/analyze@v1

‎.github/workflows/release.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Releases
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
changelog:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- name: conventional Changelog Action
15+
id: changelog
16+
uses: TriPSs/[email protected]
17+
with:
18+
github-token: ${{ secrets.CHANGELOG_RELEASE }}
19+
version-file: "./package.json,./package-lock.json"
20+
21+
- name: create release
22+
uses: actions/create-release@v1
23+
if: ${{ steps.changelog.outputs.skipped == 'false' }}
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.CHANGELOG_RELEASE }}
26+
with:
27+
tag_name: ${{ steps.changelog.outputs.tag }}
28+
release_name: ${{ steps.changelog.outputs.tag }}
29+
body: ${{ steps.changelog.outputs.clean_changelog }}

‎.github/workflows/stale.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
- name: Close Stale Issues
2+
uses: actions/[email protected]
3+
with:
4+
# Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.
5+
repo-token: # optional, default is ${{ github.token }}
6+
# The message to post on the issue when tagging it. If none provided, will not mark issues stale.
7+
stale-issue-message: # optional
8+
# The message to post on the pull request when tagging it. If none provided, will not mark pull requests stale.
9+
stale-pr-message: # optional
10+
# The message to post on the issue when closing it. If none provided, will not comment when closing an issue.
11+
close-issue-message: # optional
12+
# The message to post on the pull request when closing it. If none provided, will not comment when closing a pull requests.
13+
close-pr-message: # optional
14+
# The number of days old an issue or a pull request can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically.
15+
days-before-stale: # optional, default is 60
16+
# The number of days old an issue can be before marking it stale. Set to -1 to never mark issues as stale automatically. Override "days-before-stale" option regarding only the issues.
17+
days-before-issue-stale: # optional
18+
# The number of days old a pull request can be before marking it stale. Set to -1 to never mark pull requests as stale automatically. Override "days-before-stale" option regarding only the pull requests.
19+
days-before-pr-stale: # optional
20+
# The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.
21+
days-before-close: # optional, default is 7
22+
# The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.
23+
days-before-issue-close: # optional
24+
# The number of days to wait to close a pull request after it being marked stale. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.
25+
days-before-pr-close: # optional
26+
# The label to apply when an issue is stale.
27+
stale-issue-label: # optional, default is Stale
28+
# The label to apply when an issue is closed.
29+
close-issue-label: # optional
30+
# The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").
31+
exempt-issue-labels: # optional, default is
32+
# The label to apply when a pull request is stale.
33+
stale-pr-label: # optional, default is Stale
34+
# The label to apply when a pull request is closed.
35+
close-pr-label: # optional
36+
# The labels that mean a pull request is exempt from being marked as stale. Separate multiple labels with commas (eg. "label1,label2").
37+
exempt-pr-labels: # optional, default is
38+
# The milestones that mean an issue or a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2").
39+
exempt-milestones: # optional, default is
40+
# The milestones that mean an issue is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the issues.
41+
exempt-issue-milestones: # optional, default is
42+
# The milestones that mean a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the pull requests.
43+
exempt-pr-milestones: # optional, default is
44+
# Exempt all issues and pull requests with milestones from being marked as stale. Default to false.
45+
exempt-all-milestones: # optional, default is false
46+
# Exempt all issues with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the issues.
47+
exempt-all-issue-milestones: # optional, default is
48+
# Exempt all pull requests with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the pull requests.
49+
exempt-all-pr-milestones: # optional, default is
50+
# Only issues or pull requests with all of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.
51+
only-labels: # optional, default is
52+
# Only issues or pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.
53+
any-of-labels: # optional, default is
54+
# Only issues with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the issues.
55+
any-of-issue-labels: # optional, default is
56+
# Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests.
57+
any-of-pr-labels: # optional, default is
58+
# Only issues with all of these labels are checked if stale. Defaults to `[]` (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the issues.
59+
only-issue-labels: # optional, default is
60+
# Only pull requests with all of these labels are checked if stale. Defaults to `[]` (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the pull requests.
61+
only-pr-labels: # optional, default is
62+
# The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).
63+
operations-per-run: # optional, default is 30
64+
# Remove stale labels from issues and pull requests when they are updated or commented on.
65+
remove-stale-when-updated: # optional, default is true
66+
# Remove stale labels from issues when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the issues.
67+
remove-issue-stale-when-updated: # optional, default is
68+
# Remove stale labels from pull requests when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the pull requests.
69+
remove-pr-stale-when-updated: # optional, default is
70+
# Run the processor in debug mode without actually performing any operations on live issues.
71+
debug-only: # optional, default is false
72+
# The order to get issues or pull requests. Defaults to false, which is descending.
73+
ascending: # optional, default is false
74+
# Delete the git branch after closing a stale pull request.
75+
delete-branch: # optional, default is false
76+
# The date used to skip the stale action on issue/pull request created before it (ISO 8601 or RFC 2822).
77+
start-date: # optional, default is
78+
# The assignees which exempt an issue or a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2").
79+
exempt-assignees: # optional, default is
80+
# The assignees which exempt an issue from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the issues.
81+
exempt-issue-assignees: # optional, default is
82+
# The assignees which exempt a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the pull requests.
83+
exempt-pr-assignees: # optional, default is
84+
# Exempt all issues and pull requests with assignees from being marked as stale. Default to false.
85+
exempt-all-assignees: # optional, default is false
86+
# Exempt all issues with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the issues.
87+
exempt-all-issue-assignees: # optional, default is
88+
# Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.
89+
exempt-all-pr-assignees: # optional, default is
90+
# Exempt draft pull requests from being marked as stale. Default to false.
91+
exempt-draft-pr: # optional, default is false
92+
# Display some statistics at the end regarding the stale workflow (only when the logs are enabled).
93+
enable-statistics: # optional, default is true
94+
# A comma delimited list of labels to add when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.
95+
labels-to-add-when-unstale: # optional, default is
96+
# A comma delimited list of labels to remove when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.
97+
labels-to-remove-when-unstale: # optional, default is
98+
# Any update (update/comment) can reset the stale idle time on the issues and pull requests.
99+
ignore-updates: # optional, default is false
100+
# Any update (update/comment) can reset the stale idle time on the issues. Override "ignore-updates" option regarding only the issues.
101+
ignore-issue-updates: # optional, default is
102+
# Any update (update/comment) can reset the stale idle time on the pull requests. Override "ignore-updates" option regarding only the pull requests.
103+
ignore-pr-updates: # optional, default is

0 commit comments

Comments
 (0)