Skip to content

Commit

Permalink
docs: Added improvements to Github workflow (#120)
Browse files Browse the repository at this point in the history
* added CONTRIBUTING.md
* update README
* added CODEOWNERS
* added PR-templates
---------
Signed-off-by: Austin Hornhead <[email protected]>
  • Loading branch information
marchingon12 authored May 11, 2024
1 parent 53b334a commit 2729d2d
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# These owners will be the default owners for everything in Greenstash
* @starry-shivam

# Dot-files are handled by the lead dev (.gitignore and co)
.* @starry-shivam
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### Description
<!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. -->

### Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Type of change
<!--- Is this a bug fix, adding a feature... -->

### Pull Request checklist
<!-- Before submitting the PR, please address each item. Use [x] to check the boxes -->
- [ ] The commit message uses the [conventional commiting method][conv-commits].
- [ ] Made sure that your PR is not duplicate
- [ ] **Tests**: This PR includes thorough tests or an explanation of why it does not (for bug fixes/features). Your PR should pass all CI checks in our Gtihub Actions [Workflow](https://github.com/Pool-Of-Tears/GreenStash/actions)
- [ ] **Screenshots**: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (*optional*)

[conv-commits]:https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/translations_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### Tanslation language
<!--- add your translation locale here -->

### Translation checklist

<!---
Translations are done by translating the base string resources (English) under:
/app/src/main/res/values/strings.xml
You can translate most conveniently using Android Studio's XML editor, but your preferred XML text editor works too. Explore this guide from Helpshift for Android to learn more about translation strings (https://developers.helpshift.com/android/i18n/)
-->

- [ ] Provide the translated strings inside strings.xml under the appropriate folder.
- [ ] Used the correct locale code (en-US, en-GB, de, es, fr...)
- [ ] Named the folder correctly (values-[locale-code])

32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing

For bug reports and feature requests, please search in issues first (including the closed ones). If there are no duplicates, feel free to [submit an issue][issues] with an issue template.

**We'll probably ignore and close your issue if it's not using the existing templates or doesn't contain sufficient description.**

## Bug Report

When submitting a bug report, please make sure your issue contains **enough** information for reproducing the problem, including the options or the custom command being used, the link to the video, and other fields in the issue template.

## Feature Request

**GreenStash** is designed to provide users with a straightforward and effective tool for managing their finances on Android. Our focus is to offer essential budgeting functionalities in an intuitive interface, helping users track their savings effortlessly. As such, we prioritize feature requests that align with our core mission and the fundamental principles of budget management.

Our app already includes a range of features designed to assist users in budgeting effectively, such as goal setting and customizable categories. While we are open to suggestions for improvements and enhancements, we may not be able to accommodate requests for features that deviate significantly from our app's primary purpose or that are beyond the scope of traditional budget management. Therefore, we kindly ask our users to consider the app's intended functionality and limitations when submitting feature requests.

We appreciate the feedback and input from our users, and we are committed to continually improving **GreenStash** to meet the evolving needs of our user base. However, please understand that not all feature requests may be feasible or aligned with our app's mission and vision.

If you'd like to request a feature you deem necessary and useful, open a new Github issue with the Feature-Request template [here][feature-req].

## Pull Request

If you wish to contribute to the project by submitting code directly, please first leave a comment under the relevant issue or file a new issue, describe the changes you are about to make.

To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment, or ask the issue to be assigned to yourself.

## Building From Source

Fork this project, import and compile it with the latest version of [Android Studio](https://developer.android.com/studio/).

[issues]: https://github.com/Pool-Of-Tears/GreenStash/issues/new/choose
[feature-req]: https://github.com/Pool-Of-Tears/GreenStash/issues/new?assignees=&labels=enhancement&projects=&template=--feature-request.yml&title=%5BFeature+Request%5D
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<h1 align="center">GreenStash</h1>

<p align="center">
<a href="https://www.android.com"><img src="https://forthebadge.com/images/badges/built-for-android.svg"></a> <a href="https://www.github.com/starry69"><img src="https://forthebadge.com/images/badges/built-with-love.svg"/></a>
<a href="https://www.android.com"><img src="https://forthebadge.com/images/badges/built-for-android.svg"></a> <a href="https://www.github.com/Pool-Of-Tears"><img src="https://forthebadge.com/images/badges/built-with-love.svg"/></a>
</p>

<p align="center">
Expand Down Expand Up @@ -62,13 +62,17 @@
GreenStash doesn't contain any ads and doesn't sell your data.
The development of the app is financed by individual user contributions, such as you purchasing the app via Google Play or becoming a sponsor on Github ❤️

Become a [Sponser](https://github.com/sponsors/starry-shivam) on Github | Purchase it on [Google Play](https://play.google.com/store/apps/details?id=com.starry.greenstash)
Become a [Sponsor](https://github.com/sponsors/starry-shivam) on Github | Purchase it on [Google Play](https://play.google.com/store/apps/details?id=com.starry.greenstash)

------

<h2 align="center">Contributions</h2>

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change, or feel free to tackle any of the open issues present at the moment. If you're doing the latter, please leave a comment on the issue you want to contribute towards before starting to work on it.
Contributions are welcome!

>[!Note]
>
>For submitting bug reports, feature requests, questions, or any other ideas to improve, please read [CONTRIBUTING.md](/CONTRIBUTING.md) for instructions and guidelines first.
------

Expand Down Expand Up @@ -99,12 +103,18 @@ It is easiest to make a translation using the Android Studio XML editor, but you

------

<h2 align="center">Star History</h2>

[![Star History Chart](https://api.star-history.com/svg?repos=Pool-Of-Tears/Greenstash&type=Timeline)](https://star-history.com/#Pool-Of-Tears/Greenstash&Timeline)

------

<h2 align="center">License</h2>

[MIT License][license] © [Stɑrry Shivɑm][github]

[license]: /LICENSE
[github]: https://github.com/starry69
[github]: https://github.com/starry-shivam

```
MIT License
Expand Down

0 comments on commit 2729d2d

Please sign in to comment.