Contributing

Thank you for wanting to contribute to WorkDSH. This is a community project — whether you are a regular user, a plugin author, or a developer, there is a way to contribute that fits you.

Regular users: use, report, and spread the word

Report problems or odd behavior in an issue: include your operating system (macOS / Windows), application version, and reproduction steps.
Feature ideas and improvement suggestions are welcome as issues too.
Join the community channels (WeChat group, QQ group, Discord) and help other users.
Write tutorials or experience posts, or help improve and translate the documentation.
Suggest ecosystem projects for an issue.

Plugin authors: extend the ecosystem

DSH is built around plugins. If you write plugins, start with:

Plugin development: how to write ordinary DSH plugins and Desktop plugins.
DSH plugin ecosystem manifesto: our vision of an open, composable, sustainable ecosystem, and the three principles — composition first, declare clearly, compatibility first.

Plugins that follow the manifesto coexist better with other plugins and will be easier to discover and trust in the marketplace when it ships.

Developers: contribute code

Development environment

git submodule update --init --recursive
corepack yarn install --immutable
corepack yarn check   # full headless gate: build, typecheck, tests, and smokes
corepack yarn dev     # launch the application when a graphical session is available

Repository boundaries (please read before starting)

deepseek-harness/ is the pinned upstream submodule. Desktop development never edits files inside it; upstream updates land through separate pin commits.
Desktop code lives in dsh-plugin-desktop/, and WorkDSH feature packages live in workdsh-web/. The former uses the root Yarn workspace; the latter retains its own pnpm workspace. The pinned upstream deepseek-harness/ is a Git submodule.
Builds, typechecks, unit tests, and smoke checks must stay headless-safe.

Commits and pull requests

Use conventional commit messages (for example fix(desktop): ..., docs: ...).
Run yarn check and keep it green before committing.
After changing packaged dependencies or the WorkDSH Profile, verify the actual installed versions, license files, and dsh-plugin-desktop/THIRD_PARTY_NOTICES.md. Do not reuse a dependency inventory from an older release.
Documentation changes should stay bilingual and update the README.i18n.yaml hash record.
Describe the change, its motivation, and how it was verified in the PR; merge after CI passes.

Join the technical team

If you would like to help maintain WorkDSH, open a GitHub issue to suggest an area where you can contribute.

Code of conduct

Be kind and respectful, and stick to the topic. We want a community that welcomes newcomers. The Contributor Covenant applies to all project spaces.

3.1 KiB Raw Permalink Blame History