octoshrimpy
691ac19a9e
* Add DeepWiki badge Updated README to include DeepWiki badge for auto-updating deepwiki docs * docs(contributing): give DeepWiki its own section with badge The link was buried at the end of "Getting Your Pull Request Merged", a section about PR etiquette rather than reading code. Move it under its own heading at the top of Helpful Tips, where someone about to explore the codebase will actually look, and add the badge to match the README. --------- Co-authored-by: octoshrimpy <git@octo.sh>
4.7 KiB
Contributing
Contributions are greatly appreciated! There are many ways to contribute to this repository:
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. 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 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, and if you need any help please open an issue.
Update the Wiki
To update the wiki, simply navigate to the wiki tab 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.
Fix Bugs
- Find a bug that needs fixing.
- Check for duplicates / resolved issues within the issues tab.
- Create new issue only if not already existing.
- Fork the repository.
- Create a new branch, named according to issue you are fixing.
- Make your change.
- Test your change, either by building an APK or running on an emulator.
- 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
- Check for duplicates / resolved within issues tab.
- Submit the feature request only if not already existing.
- Fork the repository.
- Create a new branch, named according to the request you are implementing.
- Make your change.
- Note: Please make sure to provide detailed comments within your code to make reviewers and future contributors' lives easier.
- Test your change, either by building an APK or running on an emulator.
- 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.
Helpful Tips
Understand the Codebase
Feel free to use deepwiki LLM to understand the code structure before contributing and explore the implementation interactively.
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 and may be asked to be split apart.
Open Draft Pull Requests
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 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.