Skip to content

Commit 3b58566

Browse files
committed
feat: add issue and pr template
1 parent 9d56275 commit 3b58566

File tree

6 files changed

+135
-54
lines changed

6 files changed

+135
-54
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug Report
3+
about: Report a problem with the website or data
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
<!-- A clear and concise description of what the bug is -->
12+
13+
## Steps To Reproduce
14+
<!-- Steps to reproduce the behavior -->
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
## Expected Behavior
21+
<!-- A clear and concise description of what you expected to happen -->
22+
23+
## Screenshots
24+
<!-- If applicable, add screenshots to help explain your problem -->
25+
26+
## Environment
27+
- Device: [e.g. Desktop, iPhone, Pixel]
28+
- OS: [e.g. Windows, macOS, iOS, Android]
29+
- Browser: [e.g. Chrome, Safari]
30+
- Version: [e.g. 22]
31+
32+
## Additional Context
33+
<!-- Add any other context about the problem here -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions or Discussions
4+
url: https://github.com/yogeshpaliyal/awesome-android-tooling/discussions
5+
about: Please ask and answer questions here.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for the website
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Description
11+
<!-- A clear and concise description of the feature you'd like to see -->
12+
13+
## Problem This Solves
14+
<!-- Explain what problem this feature would solve or how it would improve the project -->
15+
16+
## Proposed Solution
17+
<!-- Describe how you think this feature should be implemented -->
18+
19+
## Alternatives Considered
20+
<!-- Describe any alternative solutions or features you've considered -->
21+
22+
## Additional Context
23+
<!-- Add any other context, screenshots, or mockups about the feature request here -->

.github/ISSUE_TEMPLATE/new-tool.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Add New Tool
3+
about: Suggest a new Android development tool to add to the collection
4+
title: "[NEW TOOL] "
5+
labels: new-tool
6+
assignees: ''
7+
8+
---
9+
10+
## Tool Information
11+
12+
**Tool Name:**
13+
<!-- The official name of the tool -->
14+
15+
**Description:**
16+
<!-- A clear, concise description (10-300 characters) explaining what the tool does and why it's useful -->
17+
18+
**Documentation Link:**
19+
<!-- URL to the official documentation or repository (must start with http:// or https://) -->
20+
21+
**Tool Category:**
22+
<!-- Select one or more categories -->
23+
- [ ] Command Line Tool
24+
- [ ] Android Studio Tool
25+
- [ ] Jetpack Compose Tool
26+
- [ ] Other (please specify)
27+
28+
**Tags:**
29+
<!-- List relevant tags that describe the tool's functionality, separated by commas -->
30+
31+
## Additional Information
32+
33+
**Why is this tool valuable for Android developers?**
34+
<!-- Briefly explain why this tool should be included in the collection -->
35+
36+
**Screenshots or Examples:**
37+
<!-- If applicable, add screenshots or examples of the tool in action -->
38+
39+
**Additional context:**
40+
<!-- Add any other context about the tool here -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Description
2+
<!-- Provide a brief summary of the changes in this pull request -->
3+
4+
## Type of Change
5+
<!-- Check relevant options by putting an `x` inside the brackets -->
6+
- [ ] New tool addition
7+
- [ ] Bug fix (non-breaking change that fixes an issue)
8+
- [ ] New feature (non-breaking change that adds functionality)
9+
- [ ] Documentation update
10+
- [ ] Code refactoring
11+
- [ ] Other (please describe):
12+
13+
## How Has This Been Tested?
14+
<!-- Describe how you tested your changes -->
15+
- [ ] I've validated the JSON data with `bun run validate`
16+
- [ ] I've tested the website locally with `bun run dev`
17+
- [ ] I've verified all links work correctly
18+
19+
## Checklist
20+
<!-- Check relevant options by putting an `x` inside the brackets -->
21+
- [ ] My code follows the code style of this project
22+
- [ ] I have updated the documentation as needed
23+
- [ ] My changes generate no new warnings or errors
24+
- [ ] For new tool additions:
25+
- [ ] I've included all required fields (name, description, link, tags)
26+
- [ ] The link is valid and points to official documentation
27+
- [ ] The description is clear and concise
28+
- [ ] I've added appropriate tags
29+
30+
## Screenshots
31+
<!-- If applicable, add screenshots to help explain your changes -->
32+
33+
## Additional Context
34+
<!-- Add any other context about the pull request here -->

README copy.md

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

0 commit comments

Comments
 (0)