From 2729d2d4088879dec15147e5ca67eef65f801a4e Mon Sep 17 00:00:00 2001 From: Austin Hornhead Date: Sat, 11 May 2024 11:38:03 +0200 Subject: [PATCH] docs: Added improvements to Github workflow (#120) * added CONTRIBUTING.md * update README * added CODEOWNERS * added PR-templates --------- Signed-off-by: Austin Hornhead --- .github/CODEOWNERS | 5 +++ .../pull_request_template.md | 20 ++++++++++++ .../translations_template.md | 17 ++++++++++ CONTRIBUTING.md | 32 +++++++++++++++++++ README.md | 18 ++++++++--- 5 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/translations_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..de47b5e7 --- /dev/null +++ b/.github/CODEOWNERS @@ -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 \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..4c8087a6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,20 @@ +### Description + + +### Related Issue + + + + + +## Type of change + + +### Pull Request checklist + +- [ ] 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 \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/translations_template.md b/.github/PULL_REQUEST_TEMPLATE/translations_template.md new file mode 100644 index 00000000..32b6ee13 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/translations_template.md @@ -0,0 +1,17 @@ +### Tanslation language + + +### Translation checklist + + + +- [ ] 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]) + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c5fbd5c3 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index 24672cde..58a873d3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

GreenStash

- +

@@ -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) ------

Contributions

-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. ------ @@ -99,12 +103,18 @@ It is easiest to make a translation using the Android Studio XML editor, but you ------ +

Star History

+ +[![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) + +------ +

License

[MIT License][license] © [Stɑrry Shivɑm][github] [license]: /LICENSE -[github]: https://github.com/starry69 +[github]: https://github.com/starry-shivam ``` MIT License