docs: Improve readme, add PR templates, contribution guidelines & more (

#194)

* docs: Added improvements to Github workflow
* added CONTRIBUTING.md
* update README
* added CODEOWNERS
* added PR-templates
---------
* docs: updated contribution guidelines for better clarity
- included options in the pull_request_template.md for simplified selection
- renamed original pull_request_template.md to general_template.md
- added info on conventional commits and available PR templates
---------
* docs: rename everything with GreenStash to Myne from cherrypicking
---------
* added back line break spacing
---------

Signed-off-by: marchingon12 <[email protected]>

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# These owners will be the default owners for everything in Myne
+*                               @starry-shivam
+
+# Dot-files are handled by the lead dev (.gitignore and co)
+.*                              @starry-shivam

.github/PULL_REQUEST_TEMPLATE/general_template.md

@@ -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/Myne/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

.github/PULL_REQUEST_TEMPLATE/translations_template.md

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

.github/pull_request_template.md

@@ -0,0 +1,3 @@
+Please go the the `Preview` tab and select the appropriate sub-template:
+- [General PR](?expand=1&template=general_template.md): for all other PRs, including bug fixes, adding features etc.
+- [Translation PR](?expand=1&template=translations_template.md): specifically to be used for translation PRs

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# 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
+
+**Myne** is an ebook library client designed to give users easy access to the Gutenberg Project’s extensive collection of free assets. Our goal is to make exploring and enjoying literature straightforward and enjoyable. We focus on feature requests that fit our core mission and the essential principles of ebook accessibility and management.
+
+Our library already includes a variety of features to enhance your reading experience, such as robust search capabilities, customizable reading settings, and efficient download options. While we're open to suggestions for improvements, we may not be able to accommodate requests that stray too far from our primary purpose or go beyond the scope of ebook management and accessibility. We kindly ask users to consider the library'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 **Myne** 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.
+
+As per our project's guidelines, we adhere to [conventional commits][conv-commits]. Therefore, it's expected that all PRs align with this convention. Should a PR not meet these standards, we'll kindly request a review and revision.
+
+Please use the provided Pull Request templates according to your needs. Currently, there are two to choose from:
+- [General PR](.github/PULL_REQUEST_TEMPLATE/general_template.md): for all other PRs, including bug fixes, adding features etc.
+- [Translation PR](.github/PULL_REQUEST_TEMPLATE/translations_template.md): specifically to be used for translation PRs
+
+> [!TIP]
+>
+> 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/Myne/issues/new/choose
+[feature-req]: https://github.com/Pool-Of-Tears/Myne/issues/new?assignees=&labels=enhancement&projects=&template=--feature-request.yml&title=%5BFeature+Request%5D
+[conv-commits]:https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index

README.md

@@ -72,7 +72,11 @@ Become a [Sponser](https://github.com/sponsors/starry-shivam) on Github | Purcha
 
 <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.
 
 ------
 
@@ -104,12 +108,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/Myne&type=Timeline)](https://star-history.com/#Pool-Of-Tears/Myne&Timeline)
+
+------
+
 <h2 align="center">License</h2>
 
 [Apache License 2.0][license] © [Stɑrry Shivɑm][github]
 
 [license]: /LICENSE
-[github]: https://github.com/starry69
+[github]: https://github.com/starry-shivam
 
 ```
 Copyright (c) [2022 - Present] Stɑrry Shivɑm