Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 6.39 KB

README.md

File metadata and controls

78 lines (56 loc) · 6.39 KB

General-Discussion

A place for discussing all apps in general + anything else you want to say.

FAQ

How do I suggest an improvement, ask a question or report an issue?

  1. This general discussion repository is used for bugs and suggestions that affect multiple apps. For issues affecting only 1 app, use its separate repository.
  2. If you are reporting a bug, provide steps for reproducing, and mention your app and OS version.
  3. Ensure you use the latest app version and read the in-app FAQ before reporting anything.
  4. Check if the issue has already been reported. Use search with some keywords.
  5. If the feature request is already reported, give it a "👍" to increase its priority and please avoid comments like +1 or I need this too! as they do not add anything useful.
  6. If the bug is already reported and has needs triage and/or device/software specific labels, write a comment mentioning your device model and OS version. Any additional information like reproduction steps or screenshots will be greatly appreciated.
  7. Please make sure to report your issue in English only, it'll be ignored otherwise. You can use translators if you need to.

Contribution rules for developers

These rules exist to keep the codebase consistent, maintainable and easy to build on. Please read them carefully before contributing.

  1. Always format the code (Ctrl + Alt + L) and optimize imports (Ctrl + Alt + O) before submitting a pull request.
  2. If you add a new icon, prefix it with ic_, make sure it is white, and use vector drawables whenever possible.
  3. If you make UI changes, test them with all themes including Light, Dark, Black & White, and System default (on Android 12 and above). Also test with the largest system font size.
  4. Follow the existing code style and naming conventions. Do not introduce your own style. Blending in is the best way to maintain consistency.
  5. Always use brackets, even for one-line if, return, or continue statements.
  6. Use clear, descriptive commit messages. Avoid generic messages like “fix” or “update.” Comment your code only when necessary. Avoid obvious comments, and use commit messages to explain the intent behind changes when needed.
  7. Before fixing a bug or adding a feature, make sure it is already reported in the repository, is open, and does not have the needs triage label. If the issue is closed or still has needs triage label, your PR will likely be rejected. The only exception is for critical bugs that have not been classified yet.
  8. Do not submit incomplete or bare-bones pull requests. They will likely be rejected. Every change should be well-researched, thoroughly tested, and production-ready. Small adjustments are fine, but if it is not ready for real-world usage, it is not ready for a PR. Avoid using PRs as a way to brainstorm or ask “what if?” questions. Use relevant issues or discussions for that instead. If you’re unsure how to design a feature, feel free to take inspiration from other popular apps.
  9. Pull requests that modify build configuration, dependencies, or SDK versions will not be accepted unless explicitly requested.

How can I suggest an edit to a file?

Creating pull requests with some changes is a lot simpler than most people think. Most suggestions are related to translating strings, there are 2 ways to do it.

You can find our apps on Weblate at https://hosted.weblate.org/projects/fossify/, you can see untranslated strings there easily.

However, if you prefer the old-style file updating via Github, you can still do it. The process is the following:

  1. Log in to GitHub.
  2. Find the file with the strings (app/src/main/res/values(-xx)/strings, for example, the Italian translation of the Gallery is at https://github.com/FossifyOrg/Gallery/blob/master/app/src/main/res/values-it/strings.xml).
  3. Click the pencil button at the top right corner of the file.
  4. Edit the file with your suggestions.
  5. Add a commit message under the file, to the text field which has a hint similar to "Update strings.xml". Just type in what you have done, for example, "updating Spanish strings".
  6. Click Propose file change.
  7. Click the green button Create pull request.
  8. Thank yourself!
  • Change only the string which is between ">" and </string>, not the first one after the "name=" tag, also not the strings between <!-- and -->.
  • Please escape apostrophes, meaning you have to put a backslash before every apostrophe to make it look like: \'

To find the proper language file at the Gallery, go to https://github.com/FossifyOrg/Gallery/blob/master/app/src/main/res, then look for a "values-[language code]" folder. Use the strings.xml file inside it. If you can't find your language code, the file might not be translated to your language at all yet, and you will have to create a whole new file.

How do I add a new file?

You will most likely want to add a new file only if you translate an app into a new language. Doing it is actually not difficult at all, just read on.

  1. Log in to GitHub.
  2. Find the place where the new file belongs. If it's really a translation of the strings in a new language, go to app/src/main/res, for example https://github.com/FossifyOrg/Camera/tree/master/app/src/main/res.
  3. At the top right corner click at Create new file.
  4. After the res folder, you can type in your folder path. For creating a German translation just type in values-de/ (where de is the country code). The new folder will be added automatically after typing the slash.
  5. Add a file name, i.e., strings.xml (the path should look similar to the image below) Github new file path
  6. Copy the contents of an already existing strings.xml file into the new file (for example, the content of https://github.com/FossifyOrg/Camera/blob/master/app/src/main/res/values/strings.xml).
  7. Add your string translations.
  8. Add a commit message under the file, to the text field which has a "Create new file" hint. Just type in what you have done, for example, "adding Spanish strings".
  9. Press Propose new file.
  10. Click the green button Create pull request.
  11. Thank yourself!
  • Change only the string which is between ">" and </string>, not the first one after the "name=" tag.
  • Please escape apostrophes, meaning you have to put a backslash before every apostrophe to make it look like: \'