Skip to content

Commit 7aec6ad

Browse files
VREMSoftwareDevelopmentVREMSoftwareDevelopment
committed
update templates
1 parent 43676aa commit 7aec6ad

File tree

11 files changed

+341
-168
lines changed

11 files changed

+341
-168
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Bug report
2+
description: Create a report to help us fix the issue
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting an issue — please fill in the fields below. Do not include passwords or other sensitive information.
10+
- type: input
11+
id: short_title
12+
attributes:
13+
label: Short title
14+
description: One-line summary of the bug
15+
placeholder: App crashes when scanning
16+
required: true
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Describe the bug
21+
description: A clear and concise description of the problem
22+
required: true
23+
- type: textarea
24+
id: steps
25+
attributes:
26+
label: Steps to reproduce
27+
description: Exact steps to reproduce the behavior
28+
placeholder: 1) Open app\n2) Tap Scan\n3) Observe crash
29+
required: true
30+
- type: dropdown
31+
id: reproduction_frequency
32+
attributes:
33+
label: Reproduction frequency
34+
options:
35+
- Always
36+
- Sometimes
37+
- Rarely
38+
required: true
39+
- type: dropdown
40+
id: severity
41+
attributes:
42+
label: Severity / Impact
43+
options:
44+
- Low
45+
- Medium
46+
- High
47+
required: true
48+
- type: input
49+
id: device_model
50+
attributes:
51+
label: Device model
52+
placeholder: e.g. Pixel 6, Samsung S21
53+
required: true
54+
- type: input
55+
id: android_version
56+
attributes:
57+
label: Android version / API level
58+
placeholder: e.g. Android 12 (API 31)
59+
required: true
60+
- type: input
61+
id: app_version
62+
attributes:
63+
label: WiFiAnalyzer version
64+
placeholder: e.g. 3.2.1
65+
required: true
66+
- type: textarea
67+
id: logs
68+
attributes:
69+
label: Relevant logcat lines (optional)
70+
description: Capture with `adb logcat -v time > logcat.txt` and paste the most relevant lines or attach the file.
71+
required: false
72+
- type: textarea
73+
id: additional_context
74+
attributes:
75+
label: Additional context
76+
description: Any other information (network setup, nearby APs, whether it occurs on other devices)
77+
required: false
78+

‎.github/ISSUE_TEMPLATE/default.md‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
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+
**Please search issues (open and closed) to see if the feature has already been requested.**
10+
11+
Thanks for suggesting a feature — please fill in the fields below. Do not include passwords or other sensitive information.
12+
- type: input
13+
id: short_title
14+
attributes:
15+
label: Short title
16+
description: One-line summary of the feature
17+
required: true
18+
- type: textarea
19+
id: problem
20+
attributes:
21+
label: Is your feature request related to a problem? Please describe.
22+
description: Describe the problem or use-case this feature solves
23+
required: true
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Describe the solution you'd like
28+
required: true
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Describe alternatives you've considered
33+
required: false
34+
- type: input
35+
id: willing_to_help
36+
attributes:
37+
label: How I can help
38+
description: e.g. PR, testing, design
39+
required: false
40+
- type: dropdown
41+
id: reproduction_frequency
42+
attributes:
43+
label: Reproduction / Occurrence frequency
44+
options:
45+
- Always
46+
- Sometimes
47+
- Rarely
48+
required: false
49+
- type: dropdown
50+
id: priority
51+
attributes:
52+
label: Priority / Impact
53+
options:
54+
- Low
55+
- Medium
56+
- High
57+
required: false
58+
- type: markdown
59+
attributes:
60+
value: |
61+
**Provide Device / Android OS information**
62+
Please include device and OS details if the request is device-specific. You can find Android details in Settings → About phone and WiFiAnalyzer version in Menu → About.
63+
- type: input
64+
id: device_model
65+
attributes:
66+
label: Device model
67+
placeholder: e.g. Pixel 6, Samsung S21
68+
required: false
69+
- type: input
70+
id: android_version
71+
attributes:
72+
label: Android version
73+
placeholder: e.g. Android 12
74+
required: false
75+
- type: input
76+
id: android_api_level
77+
attributes:
78+
label: Android API level
79+
placeholder: e.g. 31
80+
required: false
81+
- type: input
82+
id: app_version
83+
attributes:
84+
label: WiFiAnalyzer version
85+
placeholder: e.g. 3.2.1
86+
required: false
87+
- type: input
88+
id: build_variant
89+
attributes:
90+
label: Build variant
91+
placeholder: e.g. debug / release
92+
required: false
93+
- type: textarea
94+
id: additional_context
95+
attributes:
96+
label: Additional context
97+
description: Any other information that may help (network setup, similar behavior on other devices)
98+
required: false
99+
- type: textarea
100+
id: attachments
101+
attributes:
102+
label: Screenshots / Mockups / Attachments (optional)
103+
description: Attach screenshots or mockups to illustrate the feature.
104+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Thanks for sending a pull request!
2+
3+
See CONTRIBUTING.md for details: https://github.com/VREMSoftwareDevelopment/WiFiAnalyzer/blob/main/CONTRIBUTING.md
4+
5+
## Summary
6+
- One-line summary of the change.
7+
- Brief explanation of why this change is needed.
8+
9+
## What does this implement/fix?
10+
- Describe the scope of the change (key files, classes, public API).
11+
- Mention if the change is small and focused or broad.
12+
13+
## Does this close any issues?
14+
- Closes #<issue-number> (if applicable)
15+
- Related to #<issue-number> (if applicable)
16+
17+
## How was this tested?
18+
- Devices / OS (e.g. Android 13 emulator, Pixel 6):
19+
- Platform / Build variant (e.g. debug/release):
20+
- Toolchain / Gradle / SDK version(s):
21+
- Steps to reproduce / test (provide exact steps so reviewers can verify):
22+
23+
Example test commands:
24+
```bash
25+
./gradlew ktlintCheck
26+
./gradlew lintDebug
27+
./gradlew testDebugUnitTest
28+
```
29+
30+
## Checklist (required before marking ready)
31+
- [ ] I added or updated unit tests (see `app/src/test/`)
32+
- [ ] I followed the project's coding style (ktlint) and formatting
33+
- [ ] I ran lint and addressed or documented any warnings
34+
- [ ] CI checks pass (unit tests, coverage, lint)
35+
- [ ] No sensitive data, keys, or secrets are included
36+
37+
## Additional context
38+
- Screenshots, logs, or other context that helps reviewers understand the change.
39+
- Migration notes or compatibility considerations (if applicable).
40+
41+
## Reviewer notes
42+
- Call out anything reviewers should pay special attention to (performance, API changes, backwards compatibility, security).
43+
- Suggested reviewers or teams (optional): @maintainers
44+
45+
Thank you for contributing!
46+

‎.github/workflows/close-empty-xml.yml‎

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,46 @@ jobs:
2121
echo "$FILES"
2222
echo "files=$FILES" >> $GITHUB_OUTPUT
2323
- name: Check for meaningful XML content
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2427
run: |
28+
# Read the list of files produced by the previous step. It may be empty.
29+
FILES="${{ steps.list_files.outputs.files }}"
30+
31+
echo "Files variable content: [${FILES}]"
32+
33+
# If no xml files changed, close the PR with a comment and exit cleanly.
34+
if [ -z "$FILES" ]; then
35+
echo "No XML files changed. Closing PR."
36+
gh pr close ${{ github.event.pull_request.number }} --comment "Closed: No meaningful translation content in XML files." || true
37+
exit 0
38+
fi
39+
40+
# Assume empty until we find a <string entry in any of the modified xml files.
2541
EMPTY=true
26-
for file in ${{ steps.list_files.outputs.files }}; do
42+
43+
# Use a while-read loop with here-string to handle filenames with spaces/newlines safely.
44+
while IFS= read -r file; do
45+
# Skip blank lines
46+
[ -z "$file" ] && continue
47+
48+
# Skip if file doesn't exist in the checkout (defensive)
49+
if [ ! -f "$file" ]; then
50+
echo "Warning: file not found: $file (skipping)"
51+
continue
52+
fi
53+
54+
# If the file contains a <string tag, treat this as meaningful content and stop.
2755
if grep -q '<string' "$file"; then
2856
EMPTY=false
2957
break
3058
fi
31-
done
59+
done <<< "$FILES"
60+
3261
if $EMPTY; then
3362
echo "No meaningful XML content found. Closing PR."
34-
gh pr close ${{ github.event.pull_request.number }} --comment "Closed: No meaningful translation content in XML files."
63+
gh pr close ${{ github.event.pull_request.number }} --comment "Closed: No meaningful translation content in XML files." || true
3564
else
3665
echo "Meaningful content found. PR stays open."
37-
env:
38-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
66+
fi

0 commit comments

Comments
 (0)