Guide

Contributing to Easydict

On this page

Issues and pull requests are welcome.

How to contribute

  • Before reporting a bug, search existing issues and include reproduction steps, your version, and any logs or screenshots you can share publicly.
  • For larger feature, interface, or architecture changes, discuss the goal and user experience first.
  • Small, focused fixes, documentation, localization, and test improvements can go straight to a pull request.
  • Keep each pull request focused. Leave out unrelated changes, local configuration, secrets, and user data.

Working with a coding agent

Read AGENTS.md and the documentation it points to before getting started. Tools such as Codex or Claude can help read code, analyze problems, plan changes, and review patches. Contributors are responsible for understanding and verifying the resulting code, matching the project’s architecture and requirements, and removing unsupported assumptions or unrelated changes.

Shared skills such as review, review-pr, submit-pr, git-commit, and worktree-rebase-merge are maintained in tisfeng/skills. Follow the upstream instructions for those skills and AGENTS.md for project-specific rules.

Build the app

See the developer build guide. Open Easydict.xcworkspace in Xcode, select the Easydict scheme, and build or run it. Check how the feature works and how its parts fit together before making changes.

Open a pull request

  • Use dev as the default base unless a maintainer specifies another branch. Open the pull request from a dedicated branch.
  • Follow the branch naming conventions. Use Angular-style commit messages and keep each commit focused.
  • Link relevant issues in the pull request template. Let maintainers decide when to close an issue or link it in the Development sidebar.
  • Describe the purpose, main changes, scope, and verification. Attach screenshots or recordings for UI changes, and update relevant tests and user docs when behavior changes.

Review and verify your changes

Review the final diff and test changes in the app before opening a pull request. Cover the reported problem, the normal workflow, and relevant edge cases. Automated checks and agent reviews complement testing in the app. For documentation-only or static changes, verify the affected links, formatting, or configuration. Report the environment, steps, results, and any coverage gaps.

Easydict uses automated reviews for GitHub pull requests. Once a pull request enters review, Codex can review it against AGENTS.md; you can also request @codex review. Address actionable feedback, explain unsupported findings, and check for conflicts and unresolved comments before asking for another review. Automated review does not replace maintainer judgment.

Review timing

The project has limited maintainer time, so manual reviews have no fixed turnaround. Focused fixes, changes supported by evidence and verification, and pull requests with clear review discussions are easier to assess. Continue improving and verifying the pull request while waiting. Maintainers make the final decision based on product direction, compatibility, and maintenance cost.

More resources