Skip to content

Commit 4734204

Browse files
jmeridthjmeridth
committed
chore: add license and setup GitHub stuff
- [x] add license (creation commons 4.0) to ensure attribution - [x] GitHub stuff - [x] codeowners so to be notified about PRs - [x] issue templates - [x] dependabot (github actions so far) - [x] stale gh action - [x] pr title gh action (conventional commits formatting) - [x] pull request template Signed-off-by: jmeridth <[email protected]>
1 parent 0603185 commit 4734204

File tree

9 files changed

+561
-0
lines changed

9 files changed

+561
-0
lines changed

‎.github/CODEOWNERS

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

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
description: Create a report to help us improve
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the bug
10+
description: A clear and concise description of what the bug is.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
attributes:
16+
label: To Reproduce
17+
description: Steps to reproduce the behavior
18+
placeholder: |
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Expected behavior
29+
description: A clear and concise description of what you expected to happen.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
attributes:
35+
label: Screenshots
36+
description: If applicable, add screenshots to help explain your problem.
37+
validations:
38+
required: false
39+
40+
- type: textarea
41+
attributes:
42+
label: Additional context
43+
description: Add any other context about the problem here.
44+
validations:
45+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: blog
5+
url: https://lostechies.com
6+
about: The LosTechies Blog

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Feature request
3+
description: Suggest an idea for this project
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Is your feature request related to a problem?
10+
description: A clear and concise description of what the problem is. Please describe.
11+
placeholder: |
12+
Ex. I'm always frustrated when [...]
13+
validations:
14+
required: false
15+
16+
- type: textarea
17+
attributes:
18+
label: Describe the solution you'd like
19+
description: A clear and concise description of what you want to happen.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Describe alternatives you've considered
26+
description: A clear and concise description of any alternative solutions or features you've considered.
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
attributes:
32+
label: Additional context
33+
description: Add any other context or screenshots about the feature request here.
34+
validations:
35+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Pull Request
2+
3+
<!--
4+
PR title needs to be prefixed with a conventional commit type
5+
(build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test)
6+
7+
It should also be brief and descriptive for a good changelog entry
8+
9+
examples: "feat: add new logger" or "fix: remove unused imports"
10+
-->
11+
12+
## Proposed Changes
13+
14+
<!-- Describe what the changes are and link to a GitHub Issue if one exists -->

‎.github/dependabot.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
commit-message:
9+
prefix: "chore(deps)"
10+
groups:
11+
dependencies:
12+
applies-to: version-updates
13+
update-types:
14+
- "minor"
15+
- "patch"

‎.github/workflows/pr_title.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Reference: https://github.com/amannn/action-semantic-pull-request
2+
---
3+
name: "Lint PR Title"
4+
5+
on:
6+
pull_request_target:
7+
types: [opened, reopened, edited, synchronize]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
main:
14+
permissions:
15+
pull-requests: read
16+
statuses: write
17+
name: Validate PR title
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
23+
with:
24+
# Configure which types are allowed (newline-delimited).
25+
# From: https://github.com/commitizen/conventional-commit-types/blob/master/index.json
26+
# listing all below
27+
types: |
28+
build
29+
chore
30+
ci
31+
docs
32+
feat
33+
fix
34+
perf
35+
refactor
36+
revert
37+
style
38+
test

‎.github/workflows/stale.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: "Close stale issues"
2+
on:
3+
schedule:
4+
- cron: "30 1 * * *"
5+
6+
permissions:
7+
issues: write
8+
pull-requests: read
9+
10+
jobs:
11+
stale:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e
15+
with:
16+
stale-issue-message: "This issue is stale because it has been open 21 days with no activity. Remove stale label or comment or this will be closed in 14 days."
17+
close-issue-message: "This issue was closed because it has been stalled for 35 days with no activity."
18+
days-before-stale: 21
19+
days-before-close: 14
20+
days-before-pr-close: -1
21+
exempt-issue-labels: keep

0 commit comments

Comments
 (0)