Skip to content

Commit 9d9453f

Browse files
GintasSGintasS
authored
Initial commit
0 parents  commit 9d9453f

20 files changed

+979
-0
lines changed

‎.github/CODEOWNERS

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

‎.github/ISSUE_TEMPLATE/01_BUG_REPORT.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help Amazing GitHub Template to improve
4+
title: "bug: "
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
# Bug Report
10+
11+
**Amazing GitHub Template version:**
12+
13+
<!-- Please specify commit or tag version. -->
14+
15+
**Current behavior:**
16+
17+
<!-- Describe how the bug manifests. -->
18+
19+
**Expected behavior:**
20+
21+
<!-- Describe what the behavior would be without the bug. -->
22+
23+
**Steps to reproduce:**
24+
25+
<!-- Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
26+
27+
**Related code:**
28+
29+
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
30+
31+
```
32+
insert short code snippets here
33+
```
34+
35+
**Other information:**
36+
37+
<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

‎.github/ISSUE_TEMPLATE/02_FEATURE_REQUEST.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "feat: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
# Feature Request
10+
11+
**Describe the Feature Request**
12+
13+
<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
14+
15+
**Describe Preferred Solution**
16+
17+
<!-- A clear and concise description of what you want to happen. -->
18+
19+
**Describe Alternatives**
20+
21+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
22+
23+
**Related Code**
24+
25+
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
26+
27+
**Additional Context**
28+
29+
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->
30+
31+
**If the feature request is approved, would you be willing to submit a PR?**
32+
Yes / No _(Help can be provided if you need assistance submitting a PR)_

‎.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Codebase improvement
3+
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc.
4+
title: "dev: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: Amazing GitHub Template Community Support
5+
url: https://github.com/dec0dOS/amazing-github-template/discussions
6+
about: Please ask and answer questions here.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--- Please provide a general summary of your changes in the title above -->
2+
3+
## Pull request type
4+
5+
<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. -->
6+
7+
Please check the type of change your PR introduces:
8+
9+
- [ ] Bugfix
10+
- [ ] Feature
11+
- [ ] Code style update (formatting, renaming)
12+
- [ ] Refactoring (no functional changes, no api changes)
13+
- [ ] Build related changes
14+
- [ ] Documentation content changes
15+
- [ ] Other (please describe):
16+
17+
## What is the current behavior?
18+
19+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
20+
21+
Issue Number: N/A
22+
23+
## What is the new behavior?
24+
25+
<!-- Please describe the behavior or changes that are being added by this PR. -->
26+
27+
-
28+
-
29+
-
30+
31+
## Other information
32+
33+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

‎.github/labels.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
- name: "breaking-change"
3+
color: ee0701
4+
description: "A breaking change for existing users."
5+
- name: "bug"
6+
color: ee0701
7+
description: "Inconsistencies or issues which will cause a problem for users or implementors."
8+
- name: "documentation"
9+
color: 0052cc
10+
description: "Solely about the documentation of the project."
11+
- name: "enhancement"
12+
color: 1d76db
13+
description: "Enhancement of the code, not introducing new features."
14+
- name: "refactor"
15+
color: 1d76db
16+
description: "Improvement of existing code, not introducing new features."
17+
- name: "performance"
18+
color: 1d76db
19+
description: "Improving performance, not introducing new features."
20+
- name: "new-feature"
21+
color: 0e8a16
22+
description: "New features or options."
23+
- name: "maintenance"
24+
color: 2af79e
25+
description: "Generic maintenance tasks."
26+
- name: "ci"
27+
color: 1d76db
28+
description: "Work that improves the continue integration."
29+
- name: "dependencies"
30+
color: 1d76db
31+
description: "Upgrade or downgrade of project dependencies."
32+
33+
- name: "in-progress"
34+
color: fbca04
35+
description: "Issue is currently being resolved by a developer."
36+
- name: "stale"
37+
color: fef2c0
38+
description: "There has not been activity on this issue or PR for quite some time."
39+
- name: "no-stale"
40+
color: fef2c0
41+
description: "This issue or PR is exempted from the stable bot."
42+
43+
- name: "security"
44+
color: ee0701
45+
description: "Marks a security issue that needs to be resolved ASAP."
46+
- name: "incomplete"
47+
color: fef2c0
48+
description: "Marks a PR or issue that is missing information."
49+
- name: "invalid"
50+
color: fef2c0
51+
description: "Marks a PR or issue that is missing information."
52+
53+
- name: "beginner-friendly"
54+
color: 0e8a16
55+
description: "Good first issue for people wanting to contribute to the project."
56+
- name: "help-wanted"
57+
color: 0e8a16
58+
description: "We need some extra helping hands or expertise in order to resolve this."
59+
60+
- name: "priority-critical"
61+
color: ee0701
62+
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
63+
- name: "priority-high"
64+
color: b60205
65+
description: "After critical issues are fixed, these should be dealt with before any further issues."
66+
- name: "priority-medium"
67+
color: 0e8a16
68+
description: "This issue may be useful, and needs some attention."
69+
- name: "priority-low"
70+
color: e4ea8a
71+
description: "Nice addition, maybe... someday..."
72+
73+
- name: "major"
74+
color: b60205
75+
description: "This PR causes a major version bump in the version number."
76+
- name: "minor"
77+
color: 0e8a16
78+
description: "This PR causes a minor version bump in the version number."

‎.github/workflows/build.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Build template
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
setup:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check out the current repo
14+
uses: actions/checkout@v2
15+
- name: Set up Python 3.9
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: "3.9"
19+
- name: Install cookiecutter
20+
run: |
21+
pip install cookiecutter
22+
- name: Invoke cookiecutter
23+
run: >-
24+
cookiecutter .
25+
--overwrite-if-exists
26+
--no-input
27+
project_name="PROJECT_NAME"
28+
repo_slug="REPO_SLUG"
29+
github_username="GITHUB_USERNAME"
30+
full_name="FULL_NAME"
31+
open_source_license="OPEN_SOURCE_LICENSE"
32+
modern_header="y"
33+
table_in_about="n"
34+
include_logo="y"
35+
include_badges="y"
36+
include_toc="y"
37+
include_screenshots="y"
38+
include_project_assistance="y"
39+
include_authors="y"
40+
include_security="y"
41+
include_acknowledgements="y"
42+
include_code_of_conduct="y"
43+
include_workflows="y"
44+
use_codeql="y"
45+
use_conventional_commits="y"
46+
use_github_discussions="n"
47+
# - name: Lint markdown files
48+
# uses: nosborn/github-action-markdown-cli@master
49+
# with:
50+
# files: REPO_SLUG/
51+
# config_file: ".markdownlint.json"
52+
- name: Compress the template folder
53+
uses: papeloto/action-zip@v1
54+
with:
55+
files: REPO_SLUG/
56+
dest: template.zip
57+
- name: Create GitHub Release
58+
uses: "marvinpinto/action-automatic-releases@latest"
59+
with:
60+
repo_token: "${{ secrets.GITHUB_TOKEN }}"
61+
automatic_release_tag: "latest"
62+
prerelease: false
63+
title: "🏗️ Precompiled template"
64+
files: |
65+
template.zip

‎.github/workflows/labels.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Sync labels
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
paths:
9+
- .github/labels.yml
10+
11+
jobs:
12+
labels:
13+
name: ♻️ Sync labels
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: ⤵️ Check out code from GitHub
17+
uses: actions/checkout@v2
18+
- name: 🚀 Run Label Syncer
19+
uses: micnncim/[email protected]
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/lint.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Lint README.md
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
paths:
9+
- README.md
10+
11+
jobs:
12+
lint:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Check out the current repo
16+
uses: actions/checkout@v2
17+
- name: Lint markdown files
18+
uses: nosborn/github-action-markdown-cli@master
19+
with:
20+
files: README.md
21+
config_file: ".markdownlint.json"

‎.github/workflows/lock.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Lock
3+
4+
on:
5+
schedule:
6+
- cron: "0 9 * * *"
7+
workflow_dispatch:
8+
9+
jobs:
10+
lock:
11+
name: 🔒 Lock closed issues and PRs
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: dessant/lock-threads@v3
15+
with:
16+
github-token: ${{ github.token }}
17+
issue-inactive-days: "30"
18+
issue-lock-reason: ""
19+
pr-inactive-days: "1"
20+
pr-lock-reason: ""

‎.github/workflows/pr-labels.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: PR Labels
3+
4+
on:
5+
pull_request_target:
6+
types: [opened, labeled, unlabeled, synchronize]
7+
8+
jobs:
9+
pr_labels:
10+
name: 🏭 Verify
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: 🏷 Verify PR has a valid label
14+
uses: jesusvasquez333/[email protected]
15+
with:
16+
github-token: "${{ secrets.GITHUB_TOKEN }}"
17+
pull-request-number: '${{ github.event.pull_request.number }}'
18+
valid-labels: >-
19+
breaking-change, bugfix, documentation, enhancement,
20+
refactor, performance, new-feature, maintenance, ci, dependencies
21+
disable-reviews: true

‎.github/workflows/stale.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Stale
3+
4+
on:
5+
schedule:
6+
- cron: "0 8 * * *"
7+
workflow_dispatch:
8+
9+
jobs:
10+
stale:
11+
name: 🧹 Clean up stale issues and PRs
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: 🚀 Run stale
15+
uses: actions/stale@v3
16+
with:
17+
repo-token: ${{ secrets.GITHUB_TOKEN }}
18+
days-before-stale: 30
19+
days-before-close: 7
20+
remove-stale-when-updated: true
21+
stale-issue-label: "stale"
22+
exempt-issue-labels: "no-stale,help-wanted"
23+
stale-issue-message: >
24+
There hasn't been any activity on this issue recently, so we
25+
clean up some of the older and inactive issues.
26+
27+
Please make sure to update to the latest version and
28+
check if that solves the issue. Let us know if that works for you
29+
by leaving a comment 👍.
30+
31+
This issue has now been marked as stale and will be closed if no
32+
further activity occurs. Thanks!
33+
stale-pr-label: "stale"
34+
exempt-pr-labels: "no-stale"
35+
stale-pr-message: >
36+
There hasn't been any activity on this pull request recently. This
37+
pull request has been automatically marked as stale because of that
38+
and will be closed if no further activity occurs within 7 days.
39+
Thank you for your contributions.

0 commit comments

Comments
 (0)