Thank you for contributing to this project! Please follow these guidelines for effective collaboration.

• Use the templates provided in .github/ISSUE_TEMPLATE/

• Clearly describe:

  • Purpose of the feature
  • Problem it solves
  • Implementation ideas

• Feature PRs must have a preceding issue

• Commit messages must include the issue number

  Example: resolve #23: Add duplicate request prevention during sync

• All PRs must include:

  • Code documentation
  • Test code or manual testing instructions
  • README/Wiki documentation updates

• Requires at least 1 reviewer's approval
• No direct pushes to main branch allowed

New platform integrations should follow this structure:

src/
  models/
    remote/
      {platform}/                         # e.g. gtask/, todoist/
        {platform}Remote.ts               # main integration class
        {platform}Settings.ts             # platform-specific Settings
        TurnInto{platform}Command.ts      # insert into platforms

1. Create a new class implementing the Remote interface:

export interface Remote {
  id: string;
  settingTab: RemoteSettingPanel;
  get(id: string): Promise<Task>;
  update(id: string, from: Task): Promise<void>;
  create(title: string, args?: Record<string, string>): Promise<Task>;
  authorize(): Promise<void>;
  unauthorize(): Promise<void>;
  checkIsAuthorized(): Promise<boolean>;
  init(): Promise<void>;
  dispose?(): void;
}

2. Implement RemoteSettingPanel for platform configuration:

export abstract class RemoteSettingPanel<TData extends object = object> {
  // Handles platform-specific settings UI and data management
}

3. Required Files:

• README.md explaining platform-specific setup
• (Optional) Test files covering core functionality
• Type definitions for platform API responses

• Follows directory structure
• Implements all required interface methods
• Has proper error handling
• Provides documentation (add README.md)
• Handles authorization securely
• Uses TypeScript types properly

• Use semantic commit messages (e.g. feat:, fix:)

• Run all checks before submitting:

  pnpm format
  pnpm lint
  pnpm test

• PRs should be concise and focused on one change at a time

All contributors will be credited in the README and GitHub insights.

Thank you for helping improve Obsidian Tasks Sync!