Skip to content

Commit 4e57b33

Browse files
committed
Prepare for public release: add LICENSE, improve README, update .gitignore
1 parent 329d6dd commit 4e57b33

File tree

4 files changed

+102
-17
lines changed

4 files changed

+102
-17
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: input
11+
id: android-version
12+
attributes:
13+
label: Android Version
14+
description: What version of Android are you running?
15+
placeholder: ex. Android 13
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: What happened?
22+
description: Also tell us, what did you expect to happen?
23+
placeholder: Tell us what you see!
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: Please copy and paste any relevant log output (if available)
31+
render: shell

.gitignore

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,54 @@
1+
# Built application files
2+
*.apk
3+
*.ap_
4+
*.aab
5+
6+
# Files for the ART/Dalvik VM
7+
*.dex
8+
9+
# Java class files
10+
*.class
11+
12+
# Generated files
13+
bin/
14+
gen/
15+
out/
16+
release/
17+
18+
# Gradle files
19+
.gradle/
20+
build/
21+
22+
# Local configuration file (sdk path, etc)
23+
local.properties
24+
25+
# Proguard folder generated by Eclipse
26+
proguard/
27+
28+
# Android Studio Navigation editor temp files
29+
.navigation/
30+
31+
# IntelliJ IDEA
132
*.iml
2-
.gradle
3-
/local.properties
4-
/.idea/caches
5-
/.idea/libraries
6-
/.idea/modules.xml
7-
/.idea/workspace.xml
8-
/.idea/navEditor.xml
9-
/.idea/assetWizardSettings.xml
33+
*.ipr
34+
*.iws
35+
.idea/
36+
37+
# MacOS
1038
.DS_Store
11-
/build
12-
/captures
13-
.externalNativeBuild
14-
.cxx
15-
local.properties
1639

17-
# APK files
18-
*.apk
40+
# Windows
41+
Thumbs.db
42+
ehthumbs.db
1943

20-
# Kotlin error logs
44+
# Kotlin
2145
.kotlin/
46+
47+
# External native build folder generated in Android Studio 2.2 and later
48+
.externalNativeBuild
49+
50+
# NDK
51+
obj/
52+
53+
# Android Profiling
54+
*.hprof

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Dhruv
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# notodata v2.0 - notification dataset collector
22

3-
android app for collecting notification data for research purposes.
3+
**android app for collecting notification data for research purposes.**
44

55
## what it does
66

0 commit comments

Comments
 (0)