Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #49

Merged
merged 5 commits into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: "bug"
assignees: ''
---
<!--
How to prepare your bug report.

1. ☝️ Provide a _short but descriptive title_ for this bug above.
2. 🏷 _Label_ your bug report appropriately.
- All bug reports should be labeled with the `bug` label.
4. ✅ Fill in all the relevant sections below (or delete them if not applicable).
-->

## 🌎 Environment

- Environment: <!-- e.g. Production, Staging, Dev, etc -->
- Device: <!-- e.g. Google Pixel -->
- OS: <!-- e.g. Android 11 -->
- App Version & Build: <!-- e.g. 1.0.2 (22) -->
- Possible Cause: <!-- provide a Git commit SHA, or GitHub issue/PR reference -->

## 💬 Description

<!-- Provide a clear and concise description of what the bug is. -->

## 🦶 Reproduction Steps

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## 🤔 Expected Results

<!-- Provide a clear and concise description of what you expected to happen. -->

## 😲 Actual Results

<!-- Provide a clear and concise description of what actually happened. -->

## 📸 Screenshots

<!-- If applicable, add screenshots or videos/screen recordings to help explain your problem. -->

## 📎 Attachments

<!-- Attach addition files here. Eg, logs, stack traces, crash reports, zip files, etc. -->

## 🤝 Relationships

<!-- Remember to link this bug with any other related issues. -->

- Related PRs or Issues: #xxx, #yyy
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Enhancement/Feature Request
about: Request or new feature or an enhancement to an existing feature
title: ''
labels: "enhancement"
assignees: ''
---
## 💬 User story

```gerkin
As a ...
I want ...
So that ...
```

## 📝 Notes

<!-- Additional notes on the feature -->

## 👩‍🎨 Visual Design

<!-- Attach an image or link to the design of the feature -->

## 👩‍🔧 Technical Design Notes

<!-- Provide any technical implementation notes here. Eg, service API calls, or other technical considerations -->

## 🤝 Relationships

- Other Related Issues: #xxx, #yyy
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/tech_task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Tech task
about: Create a technical task (or chore) for tracking work adjacent to features.
title: ''
labels: ''
assignees: ''
---
## ❕ Problem Statement

<!-- Clearly describe what the problem this tech task is attempting to address. -->

## 💬 Task Description

<!-- A clear and concise description of the task. -->

## 👩‍🔧 Technical Design Notes

<!-- Provide any technical design notes here. -->

## 🤝 Relationships

- Other Related Issues: #xxx, #yyy
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ The aim is to provide all of the options you'd expect from a music player, wrapp
<br/>
<img src="assets/s2_hero_image.png" width="40%"/>
<br/>
<br/>

### Features

Expand Down Expand Up @@ -43,3 +42,7 @@ If you have features or fixes, I ask that you please consider contributing to th

This codebase represents years of hard work and learning as I've matured as an Android developer. I humbly request that you don't release low-effort clones for the sake of removing the pay-wall, or
providing your own ads/other monetization strategies. If the app should be free, I'd rather make it that way myself.

## Contributing to the Project

Please read the [contribution guide](CONTRIBUTING.md) for details on how to contribute to this project.
Loading