Skip to content

Commit 039b413

Browse files
Copilotnpv2k1
Copilot
and
npv2k1
committed
feat: add issue templates, PR template, and GitHub badges
Co-authored-by: npv2k1 <73846954+npv2k1@users.noreply.github.com>
1 parent be1af11 commit 039b413

6 files changed

Lines changed: 233 additions & 0 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
# patreon: # Replace with a single Patreon username
5+
# open_collective: # Replace with a single Open Collective username
6+
# ko_fi: # Replace with a single Ko-fi username
7+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
# liberapay: # Replace with a single Liberapay username
10+
# issuehunt: # Replace with a single IssueHunt username
11+
# otechie: # Replace with a single Otechie username
12+
# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Tell us what you see!
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. Scroll down to '...'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected
35+
attributes:
36+
label: Expected Behavior
37+
description: A clear and concise description of what you expected to happen.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: screenshots
51+
attributes:
52+
label: Screenshots
53+
description: If applicable, add screenshots to help explain your problem.
54+
55+
- type: dropdown
56+
id: os
57+
attributes:
58+
label: Operating System
59+
options:
60+
- Windows
61+
- macOS
62+
- Linux
63+
- Other
64+
validations:
65+
required: true
66+
67+
- type: input
68+
id: node-version
69+
attributes:
70+
label: Node.js Version
71+
description: Output of `node --version`
72+
placeholder: v20.0.0
73+
validations:
74+
required: true
75+
76+
- type: input
77+
id: electron-version
78+
attributes:
79+
label: Electron Version
80+
description: Check package.json or node_modules
81+
placeholder: 39.2.6
82+
83+
- type: textarea
84+
id: additional
85+
attributes:
86+
label: Additional Context
87+
description: Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Ask a Question
4+
url: https://github.com/pnstack/template-electron/discussions
5+
about: Ask questions and discuss with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/pnstack/template-electron/blob/main/README.md
8+
about: Read the documentation
9+
- name: 🔒 Security Issue
10+
url: https://github.com/pnstack/template-electron/security/policy
11+
about: Report security vulnerabilities

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature!
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like
25+
placeholder: A clear and concise description of what you want to happen.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe alternatives you've considered
34+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
35+
36+
- type: textarea
37+
id: additional
38+
attributes:
39+
label: Additional Context
40+
description: Add any other context or screenshots about the feature request here.
41+
42+
- type: dropdown
43+
id: complexity
44+
attributes:
45+
label: Implementation Complexity
46+
description: How complex do you think this feature would be to implement?
47+
options:
48+
- Low (minor changes)
49+
- Medium (moderate changes)
50+
- High (significant changes)
51+
- Not sure
52+
validations:
53+
required: false
54+
55+
- type: checkboxes
56+
id: contribution
57+
attributes:
58+
label: Contribution
59+
description: Would you be willing to contribute this feature?
60+
options:
61+
- label: I'd like to work on this feature
62+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## Description
2+
<!-- Provide a clear and concise description of your changes -->
3+
4+
## Type of Change
5+
<!-- Mark the relevant option with an "x" -->
6+
7+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
8+
- [ ] ✨ New feature (non-breaking change which adds functionality)
9+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] 📝 Documentation update
11+
- [ ] 🎨 Style/UI update
12+
- [ ] ♻️ Code refactoring
13+
- [ ] ⚡ Performance improvement
14+
- [ ] ✅ Test update
15+
16+
## Related Issues
17+
<!-- Link related issues here using #issue_number -->
18+
19+
Fixes #
20+
Related to #
21+
22+
## Changes Made
23+
<!-- List the specific changes made in this PR -->
24+
25+
-
26+
-
27+
-
28+
29+
## Testing
30+
<!-- Describe the tests you ran to verify your changes -->
31+
32+
- [ ] Type checking passes (`npx tsc --noEmit`)
33+
- [ ] Build succeeds (`npm run build`)
34+
- [ ] Electron app builds (`npm run electron:build`)
35+
- [ ] Tested on Windows
36+
- [ ] Tested on macOS
37+
- [ ] Tested on Linux
38+
- [ ] Manual testing performed
39+
40+
## Screenshots
41+
<!-- If applicable, add screenshots to demonstrate the changes -->
42+
43+
## Checklist
44+
<!-- Mark completed items with an "x" -->
45+
46+
- [ ] My code follows the style guidelines of this project
47+
- [ ] I have performed a self-review of my own code
48+
- [ ] I have commented my code, particularly in hard-to-understand areas
49+
- [ ] I have made corresponding changes to the documentation
50+
- [ ] My changes generate no new warnings
51+
- [ ] I have checked my code and corrected any misspellings
52+
- [ ] Any dependent changes have been merged and published
53+
54+
## Additional Notes
55+
<!-- Add any additional notes, considerations, or context here -->

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Template Electron
22

3+
[![CI](https://github.com/pnstack/template-electron/workflows/CI/badge.svg)](https://github.com/pnstack/template-electron/actions/workflows/ci.yml)
4+
[![Release](https://github.com/pnstack/template-electron/workflows/Release/badge.svg)](https://github.com/pnstack/template-electron/actions/workflows/release.yml)
5+
[![Code Quality](https://github.com/pnstack/template-electron/workflows/Code%20Quality/badge.svg)](https://github.com/pnstack/template-electron/actions/workflows/quality.yml)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
38
A modern, production-ready Electron application template built with TypeScript, React, and TailwindCSS.
49

510
## 🚀 Features

0 commit comments

Comments
 (0)