Clarify i18n process in contributing

Open
  • Is something wrong?
#17 0 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation, internationalization, localization

Research direction

Start by locating the contributing guidance and any pull request template, then read related issue #16. Decide which location should explain review expectations for localized documentation and how contributors should identify languages they did or did not review; done means the process is unambiguous.

Written by the indexing model from the issue text.

Description

We should probably clarify that we don't expect contributors to review the changes made to other localized versions of documentation.

This could possibly just be in a PR template? We can also have the contributor list which languages they didn't or did review, so that other people fluent in the language will know to review it, etc.

Related: https://github.com/Comfy-Org/embedded-docs/issues/16

Dominant language
Python
Stars
66
Forks
35
Avg merge
1d 5h
Merged PRs (30d)
42

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Comfy-Org/embedded-docs

All issues in Comfy-Org/embedded-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.