OmniSyncDocumentation
HomeDownload

Documentation

Contributing

Pull requests are welcome. Keep changes focused and match the existing code style.

Workflow

  1. Fork the repository

    Start from nipunyatawara-dev/Omnisync.

  2. Create a feature branch

    git checkout -b feat/my-feature

  3. Develop under Electron

    Use npm run electron so the local API token and encryption secret are provisioned. See Build from source.

  4. Test and open a PR

    Run tests, push your branch, and open a pull request with a clear summary of the change and how you verified it.

Tests

npm test
npm run test:e2e

Prefer covering new behavior with Vitest unit tests when practical. Playwright covers end-to-end flows.

Bugs and feedback

OmniSync is beta software. Report bugs and request features via GitHub Issues. Include your platform, OmniSync version (or commit), and steps to reproduce.

Security reports

License

OmniSync is released under the MIT License. By contributing, you agree that your contributions are licensed under the same terms.