Skip to content

Latest commit

 

History

History
105 lines (75 loc) · 5.96 KB

CONTRIBUTING.md

File metadata and controls

105 lines (75 loc) · 5.96 KB
Raw

Contributing to Round Sync

We welcome any contribution to Round Sync, and there are multiple ways to contribute:

Reporting a bug

No one likes it if something goes wrong. However, before submitting a bug report, please make sure to check the following links:

A lot of problems are errors in rclone.conf. If you have Termux installed, you can install rclone with pkg install rclone. Then, export your config from Round Sync and select Termux as target. You can then try to check if the error also occurs in Termux. You can also export and transfer your config to a desktop PC and test it there.

If you experience the same issue on your PC or in Termux, you can use the rclone forum to post your problem. If you are really sure that you have discovered an issue in rclone itself, you can also open an issue in the rclone repository.

When filing a new bug report, answer all the questions in the template. This includes:

  • App version (e.g. v1.11.4)
  • Exact Android version (e.g. 8.1.0)
  • Your device model and manufacturer
  • An exact list of steps that leads to your issue. Please also enable local logging in Settings > Logging > Log rclone errors.
  • Paste or attach your rclone log located in Android/data/de.felixnuesse.extract/files/logs/log.txt. Make sure to remove any confidential information such as passwords, tokens or authorization info.
  • If your issue happens when using a remote, please also add a redacted version of your configuration file (passwords and tokens removed).
  • We may also ask you to test your config file on a PC or in Termux.

Localize Round Sync

  • Download strings.xml file.

  • Open the string.xml file with your favorite text editor.

  • Delete all the strings with the attribute translatable="false".

  • Translate string values from en-US (English) to that language you want to localize Round Sync. Here is an example of translating into bn-BD

    Default string values en-US

    <string name="app_name">Round Sync</string>
<string name="app_description">Rclone for Android</string>
<string name="app_short_name">Round Sync</string>

    Translated string values into bn-BD

    <string name="app_name">রাউন্ড সিঙ্ক</string>
<string name="app_description">অ্যান্ড্রয়েডের জন্য আরক্লোন</string>
<string name="app_short_name">রাউন্ড সিঙ্ক</string>

Developing

You should first make sure you have:

  • Go 1.20 installed and in your PATH
  • Java installed and in your PATH
  • Android SDK command-line tools installed OR the NDK version specified in gradle.properties installed

You can then build the app normally from Android Studio or from CLI by running:

# Debug build
./gradlew assembleOssDebug

# or release build
./gradlew assembleOssRelease

Submitting a PR

Here are a few tips on getting your PR merged:

  1. Keep your PR small. Small PRs are easier to review, easier to test and as a result can be merged quickly. If this is your first PR to Round Sync, keep it very small.
  2. Keep your PR focussed. Your PR should have a single, specific purpose. If you discover something else you'd like to improve while working on your PR, only include it if there's a direct link to the purpose of the PR.
  3. Use the style of the existing code base. Use idiomatic code whenever possible. If you have performance concerns, use the profiler to test your assumptions.
  4. Rebase your branch before creating your PR.

Requesting a new feature

We also discuss new features on GitHub. You can browse the issue for existing feature requests and join the discussion. Note that commenting generally notifies all participants of your comment. Please avoid ' 1', 'me to' or similar comments and use 👍 reactions instead.

When opening a new feature request, answer all questions in the template. This includes:

  • Searching for existing issues and discussions that already cover your request. We may close your request without comment if you fail to do this.
  • For anything related to data transfer or accessing files on your cloud storage, please first check if your idea works in rclone. If it does not work there, it will probably also not work in Round Sync.
  • Asking yourself what you can do to create this feature.
  • The version of Round Sync you are using.

You will also be asked two free-form questions:

What problem are you trying to solve?

Describe what you are trying to achieve. This may include a series of steps if you are using rclone as part of a larger workflow, or may just be a single action. Do not describe possible solutions. Keep your ideas for the next question.

You can describe this as a problem ("I cannot find a file"), or as a goal you want to achieve ("I would like to stream a video on my TV").

What should Round Sync be able to do differently to help with this problem?

Describe how you would solve your problem. This may include additional buttons, options, menus, dialogs, etc.

This two-step approach allows us to to design general solutions, that work not just for your specific situation, but for the broader Round Sync user base. It also makes it easier for other community to join the discussion and suggest different solutions.

Please keep in mind that Round Sync and rclone are developed by volunteers.