Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.16 KB

How to contribute

You can:

  • Add or improve the support of an application (Check the TODO and TOFIX tasks and pick one)
  • Improve the Mackup codebase

To speed up Pull Request (PR) approval and merger into Mackup, please follow these guidelines:

  • Keep one application supported per PR
  • Add the application to the list of supported applications in README.md
  • Add your change to the WIP section of the CHANGELOG.md
  • Sync configurations should follow the following principles:
    • Syncing should not break the application, and PRs should be tested
    • Syncing should not break any syncing functionality internal to the application
    • The configuration should sync the minimal set of data, so that syncing happens quickly. Leave large app data out of the sync configuration.
    • Do not sync any file or folder that represents some state, like session data, cache, any file specific to the local workstation.
    • Do not sync sensitive information, like clear passwords or private keys

Thank you for your contribution!