From 4afc0c542d1b4d4ca642d49929ec14ec54fa838a Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Tue, 18 Feb 2025 12:38:31 -0800 Subject: [PATCH 1/9] Create CONTRIBUTING.md Adds Submitting Issues, and Testing latest versions. --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..49231c26 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing +Contributions are greatly appreciated! There are many ways to contribute to this repository: +* Submitting Issues +* Testing Latest Versions +* Translating +* Updating the Wiki +* Fix Bugs +* Add Features +## Submitting Issues +A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it. +When reporting a bug, please make sure to provide the following information: +* Steps to reproduce the issue +* QUIK version +* Device / OS information +## Testing Latest Versions +To do this, navigate to the release tab in this repository and click on releases. There are two types of releases in Quik. The first is the `Latest Release`. It is colored green and is the version that goes out over the app stores. The other type is `Pre-Release`, which contains the latest features and may have bugs. To install this, download the apk from the release tab and install it on your phone. (Instructions can be found in the wiki for a more detailed explanation). +Once you have done this, simply use the app as normal, and report any bugs you come across. +## Translating +## Updating the Wiki +## Fix Bugs +## Add Features From 60c62b135b3c6b664044dc72c9ee105f96416b0e Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Tue, 18 Feb 2025 17:23:22 -0800 Subject: [PATCH 2/9] Update CONTRIBUTING.md Add the rest of the sections, and finish up table of contents. --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49231c26..77091ef4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ # Contributing Contributions are greatly appreciated! There are many ways to contribute to this repository: -* Submitting Issues -* Testing Latest Versions -* Translating -* Updating the Wiki -* Fix Bugs -* Add Features +* [Submitting Issues](#submitting-Issues) +* [Testing Latest Versions](#testing-latest-versions) +* [Translating](#translating) +* [Updating the Wiki](#updating-the-wiki) +* [Fix Bugs](#fix-bugs) +* [Add Features](#add-features) ## Submitting Issues A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it. When reporting a bug, please make sure to provide the following information: @@ -15,7 +15,23 @@ When reporting a bug, please make sure to provide the following information: ## Testing Latest Versions To do this, navigate to the release tab in this repository and click on releases. There are two types of releases in Quik. The first is the `Latest Release`. It is colored green and is the version that goes out over the app stores. The other type is `Pre-Release`, which contains the latest features and may have bugs. To install this, download the apk from the release tab and install it on your phone. (Instructions can be found in the wiki for a more detailed explanation). Once you have done this, simply use the app as normal, and report any bugs you come across. -## Translating -## Updating the Wiki -## Fix Bugs -## Add Features +## Translating +To translate this app navigate to `presentation/src/main/res` and find or make a values file with the language you wish to edit. Then copy over the `strings.xml` file from `presentation/src/main/res/values` and translate it. Please do not translate any string with the `translatable=false` attribute. Also, remember to make sure to insert a backslash `\` before any apostrophe `'` or quotes `"`. +## Updating the Wiki +To update the wiki, simply navigate to the wiki tab in this repository, find the file that you need to edit, and then click `Edit Page`. Then you can edit and commit your change. For more sizeable changes, and for feedback and questions please comment in [this discussion](https://github.com/octoshrimpy/quik/discussions/174).\ +## Fix Bugs +1. Find a bug that needs fixing, please check the issues tab, and if the bug isn't reported, please do so before fixing it. +2. Fork the repository. +3. Create a new branch. +4. Make your change. +5. Test your change, either by building an apk or running on an emulator. +6. Submit a pull request with your change. +**We have a build action on each pull request, if this build fails, please edit the pull request in order to make this build succed.** +## Add Features +1. Submit a feature request to the issue tab, or search through the issues for a feature request that has already been submitted. +2. Fork the repository. +3. Create a new branch. +4. Make your change. **Note: Please make sure to provide detailed comments within your code to make reviewers and future contributers lives easier.** +5. Test your change, either by building an apk or running on an emulator. +6. Submit a pull request with your change. +**We have a build action on each pull request, if this build fails, please edit the pull request in order to make this build succed.** From b441516852c24cbe22db4279870424a8ca0f3c6a Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Tue, 18 Feb 2025 17:32:20 -0800 Subject: [PATCH 3/9] Update CONTRIBUTING.md Fixed spelling and added links. --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77091ef4..ad301aba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Once you have done this, simply use the app as normal, and report any bugs you c ## Translating To translate this app navigate to `presentation/src/main/res` and find or make a values file with the language you wish to edit. Then copy over the `strings.xml` file from `presentation/src/main/res/values` and translate it. Please do not translate any string with the `translatable=false` attribute. Also, remember to make sure to insert a backslash `\` before any apostrophe `'` or quotes `"`. ## Updating the Wiki -To update the wiki, simply navigate to the wiki tab in this repository, find the file that you need to edit, and then click `Edit Page`. Then you can edit and commit your change. For more sizeable changes, and for feedback and questions please comment in [this discussion](https://github.com/octoshrimpy/quik/discussions/174).\ +To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshrimpy/quik/wiki) in this repository, find the file that you need to edit, and then click `Edit Page`. Then you can edit and commit your change. For more sizeable changes, and for feedback and questions please comment in [this discussion](https://github.com/octoshrimpy/quik/discussions/174). ## Fix Bugs 1. Find a bug that needs fixing, please check the issues tab, and if the bug isn't reported, please do so before fixing it. 2. Fork the repository. @@ -26,12 +26,12 @@ To update the wiki, simply navigate to the wiki tab in this repository, find the 4. Make your change. 5. Test your change, either by building an apk or running on an emulator. 6. Submit a pull request with your change. -**We have a build action on each pull request, if this build fails, please edit the pull request in order to make this build succed.** +**We have a build action on each pull request, if this build fails, please edit the pull request in order to make the build succeed.** ## Add Features 1. Submit a feature request to the issue tab, or search through the issues for a feature request that has already been submitted. 2. Fork the repository. 3. Create a new branch. -4. Make your change. **Note: Please make sure to provide detailed comments within your code to make reviewers and future contributers lives easier.** +4. Make your change. **Note: Please make sure to provide detailed comments within your code to make reviewers and future contributors lives easier.** 5. Test your change, either by building an apk or running on an emulator. 6. Submit a pull request with your change. -**We have a build action on each pull request, if this build fails, please edit the pull request in order to make this build succed.** +**We have a build action on each pull request, if this build fails, please edit the pull request in order to make the build succeed.** From a81e6609145efe518728728fd459dd346331ff6c Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Tue, 18 Feb 2025 17:35:47 -0800 Subject: [PATCH 4/9] Update README.md Add contributing guidelines, and moves the translations comment to contributing.md --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c8bca0c3..6c96fc67 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,8 @@ When reporting a bug, please make sure to provide the following information: - QUIK version - Device / OS information - +## Contributing +Contributions welcome! Please see the [contributing guidelines](https://github.com/Inhishonor/quik/blob/contributing/CONTRIBUTING.md) for details. ## Thank you From 34474ae97456378ae8b5e9ac0c4094c1a743a3c2 Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Tue, 18 Feb 2025 17:36:35 -0800 Subject: [PATCH 5/9] Update CONTRIBUTING.md Adds the commented out translation guideline from the README. --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad301aba..38542cfb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,11 @@ To do this, navigate to the release tab in this repository and click on releases Once you have done this, simply use the app as normal, and report any bugs you come across. ## Translating To translate this app navigate to `presentation/src/main/res` and find or make a values file with the language you wish to edit. Then copy over the `strings.xml` file from `presentation/src/main/res/values` and translate it. Please do not translate any string with the `translatable=false` attribute. Also, remember to make sure to insert a backslash `\` before any apostrophe `'` or quotes `"`. + ## Updating the Wiki To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshrimpy/quik/wiki) in this repository, find the file that you need to edit, and then click `Edit Page`. Then you can edit and commit your change. For more sizeable changes, and for feedback and questions please comment in [this discussion](https://github.com/octoshrimpy/quik/discussions/174). ## Fix Bugs From 86db755b8b499914325916cfdaff44f63647ab0d Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Mon, 24 Feb 2025 14:47:27 -0800 Subject: [PATCH 6/9] Add example build.gradle code. Added build.gradle code to build locally, Fixed a broken link. --- CONTRIBUTING.md | 44 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38542cfb..28715456 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Contributions are greatly appreciated! There are many ways to contribute to this repository: -* [Submitting Issues](#submitting-Issues) +* [Submitting Issues](#submitting-issues) * [Testing Latest Versions](#testing-latest-versions) * [Translating](#translating) * [Updating the Wiki](#updating-the-wiki) @@ -29,7 +29,7 @@ To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshr 2. Fork the repository. 3. Create a new branch. 4. Make your change. -5. Test your change, either by building an apk or running on an emulator. +5. Test your change, either by building an apk or running on an emulator. 6. Submit a pull request with your change. **We have a build action on each pull request, if this build fails, please edit the pull request in order to make the build succeed.** ## Add Features @@ -37,6 +37,44 @@ To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshr 2. Fork the repository. 3. Create a new branch. 4. Make your change. **Note: Please make sure to provide detailed comments within your code to make reviewers and future contributors lives easier.** -5. Test your change, either by building an apk or running on an emulator. +5. Test your change, either by building an apk or running on an emulator. 6. Submit a pull request with your change. **We have a build action on each pull request, if this build fails, please edit the pull request in order to make the build succeed.** +## Helpful Tips +### [build.gradle](https://github.com/octoshrimpy/quik/blob/master/presentation/build.gradle) configuration for building locally +``` + +/* + signingConfigs { + release { + def keystoreProps = new Properties() + def keystorePropsFile = rootProject.file('./.gradle/.gradlerc') + storeFile file('./my-release-key.keystore') + keyAlias 'quik_release' + if (keystorePropsFile.exists()) { + keystoreProps.load(new FileInputStream(keystorePropsFile)) + } else if (System.getenv("CI") == "true") { +// do nothing + } else { + throw new GradleException("Keystore properties file not found.") + } + storePassword keystoreProps['storePassword'] + keyPassword keystoreProps['keyPassword'] + } + } +*/ + buildTypes { + release { + minifyEnabled true + shrinkResources true + proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' + // signingConfig signingConfigs.release + } + } + + productFlavors { + withAnalytics { dimension "analytics" } + noAnalytics { + // signingConfig signingConfigs.release + } + } From 02d14b315effae4467d82cb47b4ced960b9c7571 Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Mon, 24 Feb 2025 14:55:46 -0800 Subject: [PATCH 7/9] Fix grammer. --- CONTRIBUTING.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28715456..950decfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,28 @@ # Contributing Contributions are greatly appreciated! There are many ways to contribute to this repository: -* [Submitting Issues](#submitting-issues) -* [Testing Latest Versions](#testing-latest-versions) -* [Translating](#translating) -* [Updating the Wiki](#updating-the-wiki) +* [Submitt Issues](#submitt-issues) +* [Test Latest Versions](#test-latest-versions) +* [Translate](#translate) +* [Update the Wiki](#update-the-wiki) * [Fix Bugs](#fix-bugs) * [Add Features](#add-features) -## Submitting Issues +## Submitt Issues A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it. When reporting a bug, please make sure to provide the following information: * Steps to reproduce the issue * QUIK version * Device / OS information -## Testing Latest Versions -To do this, navigate to the release tab in this repository and click on releases. There are two types of releases in Quik. The first is the `Latest Release`. It is colored green and is the version that goes out over the app stores. The other type is `Pre-Release`, which contains the latest features and may have bugs. To install this, download the apk from the release tab and install it on your phone. (Instructions can be found in the wiki for a more detailed explanation). +## Test Latest Versions +To do this, navigate to the release tab in this repository and click on releases. There are two types of releases in Quik. The first is the `Latest Release`. This is the version that is distributed over the app stores. The other type is `Pre-Release`, which contains the latest features and may have bugs. To install this, download the apk from the release tab and install it on your phone. (Instructions can be found in the wiki for a more detailed explanation). Once you have done this, simply use the app as normal, and report any bugs you come across. -## Translating +## Translate To translate this app navigate to `presentation/src/main/res` and find or make a values file with the language you wish to edit. Then copy over the `strings.xml` file from `presentation/src/main/res/values` and translate it. Please do not translate any string with the `translatable=false` attribute. Also, remember to make sure to insert a backslash `\` before any apostrophe `'` or quotes `"`. -## Updating the Wiki +## Update the Wiki To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshrimpy/quik/wiki) in this repository, find the file that you need to edit, and then click `Edit Page`. Then you can edit and commit your change. For more sizeable changes, and for feedback and questions please comment in [this discussion](https://github.com/octoshrimpy/quik/discussions/174). ## Fix Bugs 1. Find a bug that needs fixing, please check the issues tab, and if the bug isn't reported, please do so before fixing it. @@ -78,3 +78,4 @@ To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshr // signingConfig signingConfigs.release } } +``` From 7968b814612c2587f44322337eff5c0ab62d8b7c Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Mon, 24 Feb 2025 15:08:46 -0800 Subject: [PATCH 8/9] Fix typos. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 950decfc..160b46d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # Contributing Contributions are greatly appreciated! There are many ways to contribute to this repository: -* [Submitt Issues](#submitt-issues) +* [Submit Issues](#submit-issues) * [Test Latest Versions](#test-latest-versions) * [Translate](#translate) * [Update the Wiki](#update-the-wiki) * [Fix Bugs](#fix-bugs) * [Add Features](#add-features) -## Submitt Issues +## Submit Issues A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it. When reporting a bug, please make sure to provide the following information: * Steps to reproduce the issue From a15a034457e77baf0acd2029bc575e011fabfb43 Mon Sep 17 00:00:00 2001 From: Inhishonor Date: Mon, 24 Feb 2025 16:34:43 -0800 Subject: [PATCH 9/9] Change link to original repo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c96fc67..9400e555 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ When reporting a bug, please make sure to provide the following information: - Device / OS information ## Contributing -Contributions welcome! Please see the [contributing guidelines](https://github.com/Inhishonor/quik/blob/contributing/CONTRIBUTING.md) for details. +Contributions welcome! Please see the [contributing guidelines](https://github.com/octoshrimpy/quik/blob/contributing/CONTRIBUTING.md) for details. ## Thank you