Skip to content

Commit b97c03c

Browse files
author
bugfish\bugfishtm
committed
1.0
1 parent 319efea commit b97c03c

File tree

10 files changed

+95
-47
lines changed

10 files changed

+95
-47
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Code of Conduct
1+
## Code of Conduct
22

3-
### Our Pledge
3+
### 🤝 Our Pledge
44

5-
We're building cool stuff for free to push technology forward. If you're here, you're part of that mission. Let's work together, share ideas, and make awesome things happen!
5+
We're building cool stuff for free to push technology forward. If you're here, you're part of that mission. Let's work together, share ideas, and make awesome things happen!
66

7-
### Our Standards
7+
### 📏 Our Standards
88

9-
* **Positive:** Be kind, empathetic, and respectful. Give constructive feedback.
10-
* **Unacceptable:** Harassment, offensive comments, personal attacks, sharing private info without consent.
9+
* **Positive:** Be kind, empathetic, and respectful. Give constructive feedback.
10+
* **🚫 Unacceptable:** Harassment, offensive comments, personal attacks, sharing private info without consent.
1111

12-
🐟 Bugfish <3
12+
🐟 Bugfish <3

.github/CONTRIBUTING.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,36 @@
22

33
Hey there! Thanks for considering contributing to this project! We appreciate your interest and are excited to have you join our community of contributors.
44

5-
## How You Can Help
5+
## 🚀 How You Can Help
66

77
* **Report Bugs:** Found something that's not working as expected? Let us know! Clear and detailed bug reports are incredibly valuable.
88
* **Suggest Features:** Got a brilliant idea for a new feature or improvement? We'd love to hear it!
99
* **Submit Code:** Ready to roll up your sleeves and write some code? Awesome! Check out our coding style guidelines (see below) and dive in.
1010
* **Improve Documentation:** Documentation is just as important as code. Help us make it clear, concise, and easy to understand.
1111
* **Spread the Word:** Tell your friends, write blog posts, share on social media – help us get the word out!
1212

13-
## Coding Style Guidelines
13+
## 📢 Spread the Word
14+
15+
Help us grow by sharing this project with others! You can:
16+
17+
* **Tweet about it** – Share your thoughts on [Twitter/X](https://twitter.com) and tag us!
18+
* **Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.com).
19+
* **Upvote on Product Hunt** – If we're listed, give us a boost on [Product Hunt](https://www.producthunt.com)!
20+
* **Share on Reddit** – Talk about it in relevant subreddits like [r/programming](https://www.reddit.com/r/programming/) or [r/opensource](https://www.reddit.com/r/opensource/).
21+
* **Write a Blog Post** – A tutorial, review, or use-case would be awesome!
22+
* **Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.
23+
24+
## 🎨 Coding Style Guidelines
1425

1526
* Follow the existing coding style.
1627
* Write clear, concise, and well-commented code.
1728
* Keep your pull requests focused on a single issue or feature.
1829

19-
## Code of Conduct
30+
## ⚖️ Code of Conduct
2031

2132
Please note that this project has a Code of Conduct (.github/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
2233

23-
## Need Help?
34+
## Need Help?
2435

2536
If you're having trouble getting started or have any questions, feel free to reach out to us! You can:
2637

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,24 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
## Describe the bug
1111
A clear and concise description of what the bug is.
1212

13-
**To Reproduce**
13+
## To Reproduce
1414
Steps to reproduce the behavior:
1515
1. Go to '...'
1616
2. Do '....'
1717
3. See error
1818

19-
**Expected behavior**
19+
## Expected behavior
2020
A clear and concise description of what you expected to happen.
2121

22-
**Screenshots**
22+
## Screenshots
2323
If applicable, add screenshots to help explain your problem.
2424

25-
**Environment:**
25+
## Environment:
2626
- OS: [e.g. Windows, macOS, Linux]
2727
- Version [e.g. Software Version, Browser Version]
2828

29-
**Additional context**
29+
## Additional context
3030
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,11 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. "I'm always frustrated when..."
12-
13-
**Describe the solution you'd like**
10+
## Describe the solution you'd like
1411
A clear and concise description of what you want to happen.
1512

16-
**Describe alternatives you've considered**
13+
## Describe alternatives you've considered
1714
A clear and concise description of any alternative solutions or features you've considered.
1815

19-
**Additional context**
16+
## Additional context
2017
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/QUESTION.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Question
3+
about: Ask a question about the project.
4+
title: "[QUESTION] Short description of your question"
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
A clear and concise question about the project.
11+
12+
## Context
13+
Provide any relevant details, such as what you're trying to achieve, any challenges you're facing, or related documentation/code references.
14+
15+
## What Have You Tried?
16+
List any steps you've taken to find an answer, such as searching the documentation, checking previous issues, or testing solutions.
17+
18+
## 🖼Additional Information
19+
If applicable, include screenshots, code snippets, or links that might help clarify your question.
20+
21+
## Environment
22+
- OS: [e.g., Windows, macOS, Linux]
23+
- Version: [e.g., Software Version, Browser Version]
24+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
- [ ] I have tested these changes locally
1717
- [ ] I have updated the documentation accordingly
1818
- [ ] My code follows the project's coding standards
19-
- [ ] I have added/updated tests for this change
2019

2120
## Screenshots (if applicable)
2221
[Add screenshots here to demonstrate visual changes]

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ Simplify the creation of Android WebView apps with this ready-to-use Android Stu
2525
- This is the final release as this is a template project with no further enhancements planned.
2626
- The project remains open source under the GPLv3 License.
2727
- Continued support will be available for user inquiries.
28+
29+
🐟 Bugfish <3

CONTRIBUTING.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,36 @@
22

33
Hey there! Thanks for considering contributing to this project! We appreciate your interest and are excited to have you join our community of contributors.
44

5-
## How You Can Help
5+
## 🚀 How You Can Help
66

77
* **Report Bugs:** Found something that's not working as expected? Let us know! Clear and detailed bug reports are incredibly valuable.
88
* **Suggest Features:** Got a brilliant idea for a new feature or improvement? We'd love to hear it!
99
* **Submit Code:** Ready to roll up your sleeves and write some code? Awesome! Check out our coding style guidelines (see below) and dive in.
1010
* **Improve Documentation:** Documentation is just as important as code. Help us make it clear, concise, and easy to understand.
1111
* **Spread the Word:** Tell your friends, write blog posts, share on social media – help us get the word out!
1212

13-
## Coding Style Guidelines
13+
## 📢 Spread the Word
14+
15+
Help us grow by sharing this project with others! You can:
16+
17+
* **Tweet about it** – Share your thoughts on [Twitter/X](https://twitter.com) and tag us!
18+
* **Post on LinkedIn** – Let your professional network know about this project on [LinkedIn](https://www.linkedin.com).
19+
* **Upvote on Product Hunt** – If we're listed, give us a boost on [Product Hunt](https://www.producthunt.com)!
20+
* **Share on Reddit** – Talk about it in relevant subreddits like [r/programming](https://www.reddit.com/r/programming/) or [r/opensource](https://www.reddit.com/r/opensource/).
21+
* **Write a Blog Post** – A tutorial, review, or use-case would be awesome!
22+
* **Tell Your Community** – Spread the word in Discord servers, Slack groups, and forums.
23+
24+
## 🎨 Coding Style Guidelines
1425

1526
* Follow the existing coding style.
1627
* Write clear, concise, and well-commented code.
1728
* Keep your pull requests focused on a single issue or feature.
1829

19-
## Code of Conduct
30+
## ⚖️ Code of Conduct
2031

2132
Please note that this project has a Code of Conduct (.github/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
2233

23-
## Need Help?
34+
## Need Help?
2435

2536
If you're having trouble getting started or have any questions, feel free to reach out to us! You can:
2637

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Android WebApp Example
22

3-
## Introduction
3+
## 📖 Introduction
44

55
The Android WebApp Example is a ready-to-use Android Studio project designed to create a simple web app with built-in controls at the bottom, including forward, back, and home buttons. You can easily customize this web app by modifying the main.java file to specify your desired URL and then compile it to generate a finished .apk file. This project simplifies the process of creating web apps related to your website. All you need is Android Studio installed on your system, and you can quickly make the necessary changes.
66

7-
## Requirements for Compilation
7+
## ⚙️ Requirements for Compilation
88

99
This software is developed using Android Studio, and we recommend using this development environment to modify the source code and compile the project. You can simply import the source folder into Android Studio.
1010

11-
## Modifying the Source Code
11+
## 🛠️ Modifying the Source Code
1212

1313
To customize the web app for your specific needs, follow these steps:
1414

@@ -20,11 +20,11 @@ To customize the web app for your specific needs, follow these steps:
2020

2121
3. If you intend to create multiple web apps, remember to update the Gradle App-ID in the Gradle files. Using the same App-ID for multiple web apps may result in conflicts when installing them on devices simultaneously!
2222

23-
## Support and Assistance
23+
## 🤝 Support and Assistance
2424

2525
If you encounter any issues or require assistance, please visit [bugfish.eu](https://www.bugfish.eu/) for additional resources. You can also contact us at [[email protected]](mailto:[email protected]), and we will do our best to assist you.
2626

27-
## License Information
27+
## 📜 License Information
2828

2929
The license details for this Android WebApp Example project can be found in the "license.md" file within the project repository. Please review this file to understand the terms and conditions of use and distribution. It is essential to comply with the project's license to ensure legal and ethical usage of the provided resources.
3030

SECURITY.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1-
## Security Policy
1+
## Security Policy
22

3-
### Reporting a Vulnerability
3+
### 🛡️ Reporting a Vulnerability
44

5-
We take the security of our project seriously. If you discover a security vulnerability, please follow these steps:
5+
We take the security of our project seriously. If you discover a security vulnerability, please follow these steps:
66

7-
1. **Do not** create a public GitHub issue for the vulnerability.
8-
2. Email your findings to [email protected]
9-
3. Provide as much information as possible, including:
10-
- A description of the vulnerability
11-
- Steps to reproduce
12-
- Potential impact
7+
1. **Do not** create a public GitHub issue for the vulnerability.
8+
2. Email your findings to [email protected]
9+
3. Provide as much information as possible, including:
10+
- A description of the vulnerability
11+
- Steps to reproduce
12+
- Potential impact
1313

14-
### What to Expect
14+
### 🔍 What to Expect
1515

16-
- We will acknowledge receipt of your report.
17-
- We will strive to keep you informed about the progress of addressing the issue.
18-
- Once the vulnerability is confirmed and fixed, we will inform you.
16+
- We will acknowledge receipt of your report.
17+
- We will strive to keep you informed about the progress of addressing the issue.
18+
- Once the vulnerability is confirmed and fixed, we will inform you.
1919

20-
🐟 Bugfish <3
20+
### ⚖️ No Warranty
21+
22+
This project is licensed under **GPLv3**, which means it comes **without any warranty**. We provide the software **as-is**, without guarantees of security, reliability, or fitness for any purpose. Use at your own risk.
23+
24+
🐟 Bugfish <3

0 commit comments

Comments
 (0)