diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f79f5e0b..ab011219 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,45 +6,74 @@ Contributions are greatly appreciated! There are many ways to contribute to this * [Update the Wiki](#update-the-wiki) * [Fix Bugs](#fix-bugs) * [Add Features](#add-features) + + ## 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 * QUIK version * Device / OS information + + ## 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. + + ## Translate To translate this app join our [Weblate project](https://hosted.weblate.org/engage/quik/). From here you can begin editing strings on the web. We have a few guidelines for translations: * Insert a backslash `\` before any apostrophe `'` or quotes `"`. -* Use `` ` `` instead of single quotes. +* Use a backtick `` ` `` instead of single quotes. * Follow the punctuation in the English strings as much as possible. For example, don't add a `.` when there is none in the original strings. * If you are unsure of a translation, consider using a suggestion rather than translating the string. That way other translators can review it. We recommend checking out the [Weblate documentation](https://docs.weblate.org/en/latest/index.html), and if you need any help please open an issue. + + ## 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 sizable 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 want to edit, and click `Edit Page`. Edit and commit your change. For more sizable changes, or 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 the build succeed.** +1. Find a bug that needs fixing. +2. Check for duplicates / resolved issues within the issues tab. + - Create new issue only if not already existing. +3. Fork the repository. +4. Create a new branch, named according to issue you are fixing. +5. Make your change. +6. Test your change, either by building an APK or running on an emulator. +7. Submit a pull request with your change. + +**We have a build action on each pull request.**\ +**If 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. +1. Check for duplicates / resolved within issues tab. + - Submit the feature request only if not already existing. 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.** +3. Create a new branch, named according to the request you are implementing. +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 the build succeed.** + +**We have a build action on each pull request.**\ +**If build fails, please edit the pull request in order to make the build succeed.** + + ## Helpful Tips ### Getting Your Pull Request Merged -When submitting a pull request, please be as detailed as possible in your reasoning for the change, what you changed and how you tested it. In addition, please try to keep pull requests atomic and singularly focused. Submitting large pull requests that have multiple changes or touch multiple code paths are much more difficult to review. +When submitting a pull request, please be as detailed as possible in your reasoning for the change, what you changed and how you tested it. \ +In addition, please try to keep pull requests atomic and singularly focused. Submitting large pull requests that have multiple changes or touch multiple code paths are much more difficult to review and may be asked to be split apart. + +Feel free to use [deepwiki LLM](https://deepwiki.com/octoshrimpy/quik) to understand the code structure before contributing and explore the implementation interactively. + ### Open Draft Pull Requests -If you are stuck or in the middle of a larger code change, go ahead and open up a draft pull request. That way you can receive help and suggestions while you are developing. And if you are stuck on something specific open up that draft PR, or hop on over to [matrix](https://matrix.to/#/#quik-sms:matrix.org) for suggestions. +If you are stuck or in the middle of a larger code change, open up a draft pull request. That way you can receive help and suggestions while you are developing. \ +If you are stuck on something specific open up that draft PR, or hop on over to [matrix](https://matrix.to/#/#quik-sms:matrix.org) for suggestions. + + ### Set Java Version -When building QUIK, make sure to download JDK 17 and specify an installation path for it. In Android Studio, you can do that in Settings > Build, Execution, Deployment > Build Tools > Gradle. +When building QUIK, make sure to download JDK 17 and specify an installation path for it. In Android Studio, you can do that in `Settings` > `Build, Execution, Deployment` > `Build Tools` > `Gradle`. diff --git a/README.md b/README.md index 072da8c7..4ffcee6a 100644 --- a/README.md +++ b/README.md @@ -11,18 +11,23 @@ QUIK is an open source replacement to the [stock messaging app](https://github.c ## Features -- Scheduled Messages -- Message Backup -- Speech to Text and Text to Speech integrated within the app -- Message Blocking and Archiving -- Voice Messages +- Scheduled messages +- Message backup +- Speech-to-text and text-to-speech integrated within the app +- Message blocking and archiving +- Voice messages - Attachments of any type of file -- Message Sorting -- Delayed Sending +- Message sorting +- Message pinning +- Delayed sending +- Quick reply from notifications +- Swipe actions +- Emoji reaction handling +- and much, much more ## Download -QUIK is available to download from the official [github releases page](https://github.com/octoshrimpy/quik/releases), but you can also keep track of updates with [Obtainium](https://github.com/ImranR98/Obtainium#-obtainium). +Grab QUIK from the official [github releases page](https://github.com/octoshrimpy/quik/releases), or keep up with updates with the following: Get it on F-Droid @@ -47,7 +52,7 @@ When reporting a bug, please make sure to provide the following information: - Device / OS information ## Contributing -Contributions welcome! Please see the [contributing guidelines](/CONTRIBUTING.md) for details. +Contributions are very welcome! Please see the [contributing guidelines](/CONTRIBUTING.md) for details. ## Translations If you'd like to add translations to QUIK, please join the project on [Weblate](https://hosted.weblate.org/engage/quik/)! Translations that are committed directly to source files will not be accepted. For more information see the [translation guidelines](/CONTRIBUTING.md#translate). @@ -80,7 +85,7 @@ QUIK is developed and maintained by [Marcos Jones](https://github.com/octoshrimp --- -Donate using Liberapay + Donate using Ko-Fi Donate using Patreon