Skip to content

Commit 16b2ef8

Browse files
NelsonBNNelsonBN
committed
docs: Added GitHub tempates
1 parent ed30aa8 commit 16b2ef8

12 files changed

Lines changed: 389 additions & 0 deletions

‎.github/CODEOWNERS‎

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

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
name: "🐞 Bug report"
3+
description: Report a bug
4+
title: "(Short description)"
5+
labels: [bug]
6+
assignees: [NelsonBN]
7+
8+
9+
10+
body:
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the bug
15+
description: What is the problem? A clear and concise description of the bug.
16+
validations:
17+
required: true
18+
19+
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: Expected behavior
24+
description: |
25+
What did you expect to happen?
26+
validations:
27+
required: true
28+
29+
30+
- type: textarea
31+
id: current
32+
attributes:
33+
label: Current behavior
34+
description: |
35+
What actually happened?
36+
37+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
38+
If service responses are relevant, please include wire logs.
39+
validations:
40+
required: false
41+
42+
43+
- type: textarea
44+
id: reproduction
45+
attributes:
46+
label: Reproduction Steps
47+
description: |
48+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
49+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
50+
51+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
52+
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
53+
validations:
54+
required: false
55+
56+
57+
- type: textarea
58+
id: solution
59+
attributes:
60+
label: Possible Solution
61+
description: |
62+
Suggest a fix/reason for the bug
63+
validations:
64+
required: false
65+
66+
67+
- type: textarea
68+
id: context
69+
attributes:
70+
label: Additional Information/Context
71+
description: |
72+
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
73+
validations:
74+
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: false

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: "📕 Documentation issue or suggestion"
3+
description: Report an issue or a suggestion for documentation
4+
title: "(Short description)"
5+
labels: [documentation]
6+
assignees: [NelsonBN]
7+
8+
9+
10+
body:
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the issue
15+
description: A clear and concise description of the issue.
16+
validations:
17+
required: true
18+
19+
20+
- type: textarea
21+
id: links
22+
attributes:
23+
label: Links
24+
description: Include links to affected documentation page(s).
25+
validations:
26+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: "🚀 Feature request"
3+
description: "Suggest an idea for this project"
4+
title: "(Short description)"
5+
labels: [feature-request]
6+
assignees: [NelsonBN]
7+
8+
9+
10+
body:
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the feature
15+
description: A clear and concise description of the feature you are proposing.
16+
validations:
17+
required: true
18+
19+
20+
- type: textarea
21+
id: use-case
22+
attributes:
23+
label: Use Case
24+
description: Why do you need this feature? For example "I'm always frustrated when...""
25+
validations:
26+
required: true
27+
28+
29+
- type: textarea
30+
id: solution
31+
attributes:
32+
label: Proposed Solution
33+
description: Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
34+
validations:
35+
required: false
36+
37+
38+
- type: checkboxes
39+
id: ack
40+
attributes:
41+
label: Acknowledgements
42+
options:
43+
- label: I may be able to implement this feature request
44+
required: false
45+
- label: This feature might incur a breaking change
46+
required: false

‎.github/ISSUE_TEMPLATE/support.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: "💊 Support"
3+
description: "Request support about this project"
4+
title: "(short issue description)"
5+
labels: [support]
6+
assignees: [NelsonBN]
7+
8+
9+
10+
body:
11+
- type: input
12+
id: topic
13+
attributes:
14+
label: Question title
15+
placeholder: Short description of your question
16+
validations:
17+
required: true
18+
19+
20+
- type: textarea
21+
id: question
22+
attributes:
23+
label: Describe your question
24+
validations:
25+
required: true

‎.github/dependabot.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
updates:
3+
4+
- package-ecosystem: "github-actions"
5+
directory: "/" # Location of package manifests
6+
schedule:
7+
interval: "daily"
8+
assignees:
9+
- "NelsonBN"
10+
reviewers:
11+
- "NelsonBN"
12+
commit-message:
13+
prefix: "build"
14+
include: "scope"
15+
target-branch: "main"

‎.github/hooks/commit-msg‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#!/bin/sh
2+
#
3+
# An example hook script to check the commit log message.
4+
# Called by "git commit" with one argument, the name of the file
5+
# that has the commit message. The hook should exit with non-zero
6+
# status after issuing an appropriate message if it wants to stop the
7+
# commit. The hook is allowed to edit the commit message file.
8+
#
9+
# To enable this hook, rename this file to "commit-msg".
10+
11+
# Uncomment the below to add a Signed-off-by line to the message.
12+
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
13+
# hook is more suited to it.
14+
#
15+
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
16+
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
17+
18+
# This example catches duplicate Signed-off-by lines.
19+
20+
test "" = "$(grep '^Signed-off-by: ' "$1" |
21+
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
22+
echo >&2 Duplicate Signed-off-by lines.
23+
exit 1
24+
}
25+
if ! head -1 "$1" | grep -qE "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|merge)(\(.+?\))?(\!)?: .{3,}$"; then
26+
echo "Aborting commit. Your commit message is invalid. See some examples below:" >&2
27+
echo "feat(logging): added logs for failed signups" >&2
28+
echo "fix(homepage): fixed image gallery" >&2
29+
echo "test(homepage): updated tests" >&2
30+
echo "docs(readme): added new logging table information" >&2
31+
echo "For more information check https://www.conventionalcommits.org/en/v1.0.0/ for more details" >&2
32+
exit 1
33+
fi
34+
if ! head -1 "$1" | grep -qE "^.{9,85}$"; then
35+
echo "Aborting commit. Your commit message is too long. Max length is 89 characters" >&2
36+
exit 1
37+
fi

‎.github/workflows/markdown-link-check.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"aliveStatusCodes": [429, 200]
3+
}

‎.github/workflows/markdown-link-check.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 'Check Markdown links'
2+
3+
4+
on:
5+
workflow_dispatch: # To can dispatch manually
6+
7+
# Schedule to run every week on Sunday at 00:00 UTC
8+
schedule:
9+
- cron: '0 0 * * 0'
10+
11+
pull_request:
12+
types: [opened, reopened, edited, synchronize]
13+
branches:
14+
- main
15+
16+
17+
jobs:
18+
markdown-link-check:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: "Checkout"
23+
uses: actions/checkout@v4
24+
25+
- name: 'Readme analysis'
26+
uses: gaurav-nelson/github-action-markdown-link-check@v1
27+
with:
28+
use-verbose-mode: 'yes'
29+
base-branch: 'main'
30+
config-file: '.github/workflows/markdown-link-check.json'

0 commit comments

Comments
 (0)