Skip to content

World's first open-source enterprise world model.

The repository has a code of conduct, issue forms and a pull request template (#1064)

WaylandYange1e07751d60d
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..cbb05a55
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,64 @@
+name: Bug report / 报告问题
+description: Something Utopia does wrong, or does not do. 某件事做错了,或者没做。
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ English or 中文, either is fine.
+
+ Title: one sentence that says what happens, e.g. "A sheet's merged cells are read as one cell followed by blanks".
+ Not sure it is a bug? File it anyway, or ask in [Q&A](https://github.com/deeplethe/utopia/discussions/categories/q-a).
+ A security problem goes to the address in [SECURITY.md](https://github.com/deeplethe/utopia/blob/main/SECURITY.md), not here.
+ - type: textarea
+ id: what
+ attributes:
+ label: What happens, and what you expected / 现象与预期
+ validations:
+ required: true
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: How to see it / 怎么复现
+ description: >-
+ The steps, and the smallest document or sentence that shows it. Most reports about
+ extraction can only be looked at with the text that was read. Remove anything private.
+ 复现步骤,以及能复现的最小文档或句子;请去掉隐私内容。
+ validations:
+ required: true
+ - type: input
+ id: version
+ attributes:
+ label: Version / 版本
+ description: >-
+ The image tag (`docker compose images`), or the commit when built from source.
+ 镜像标签,或从源码构建时的 commit。
+ placeholder: ghcr.io/deeplethe/utopia:0.1.0-rc7, or dev @ 2e7ba78
+ validations:
+ required: true
+ - type: dropdown
+ id: deployment
+ attributes:
+ label: How it runs / 部署方式
+ options:
+ - Docker Compose, as in the README
+ - From source
+ - Other (say which below)
+ validations:
+ required: true
+ - type: input
+ id: models
+ attributes:
+ label: Models / 模型
+ description: >-
+ Chat and embedding model, and the provider or gateway they are reached through. What is
+ extracted depends on them. 对话模型与嵌入模型,以及经由哪个供应商或网关。
+ placeholder: deepseek-chat via DeepSeek; BAAI/bge-m3 via SiliconFlow
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs / 日志
+ description: >-
+ Server output around the failure (`docker compose logs app`). Remove keys and tokens.
+ 出错前后的服务端日志;请去掉密钥。
+ render: text
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..07f5dfc7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,9 @@
+# Maintainers file issues without a form, so blank issues stay on.
+blank_issues_enabled: true
+contact_links:
+ - name: Question or help with usage / 使用上的疑问
+ url: https://github.com/deeplethe/utopia/discussions/categories/q-a
+ about: Ask in Discussions. If it turns out to be a bug, we will open the issue.
+ - name: Security problem / 安全问题
+ url: https://github.com/deeplethe/utopia/blob/main/SECURITY.md#reporting-a-vulnerability
+ about: Report it by email, not in a public issue.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 00000000..7a4f1e1a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,31 @@
+name: Feature request / 功能建议
+description: Something you need Utopia to do. 希望 Utopia 能做到的事。
+labels: ["enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ English or 中文, either is fine.
+
+ Start from what you are trying to get done; the use case decides the design more than the feature does.
+ A change to the data model, the ontology contract or a public API is discussed here first and then written down as an [ADR](https://github.com/deeplethe/utopia/tree/main/docs/decisions) before any code.
+ - type: textarea
+ id: use-case
+ attributes:
+ label: What you are trying to do / 想做成什么事
+ description: >-
+ The situation, the documents or data involved, and where Utopia stops short today.
+ 场景、涉及的文档或数据,以及现在卡在哪里。
+ validations:
+ required: true
+ - type: textarea
+ id: proposal
+ attributes:
+ label: What would help / 希望怎样
+ description: >-
+ If you have a shape in mind. For an ontology pack: its name, where it is published and its
+ license. 如果已有想法;本体包请写明名称、发布地址与许可。
+ - type: textarea
+ id: tried
+ attributes:
+ label: What you do today instead / 目前的替代做法
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..9b05a587
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+<!--
+Base branch: dev, not main.
+Title: one English sentence stating what changes; it becomes the commit on dev.
+CONTRIBUTING.md has the details behind every line below.
+-->
+
+## Why
+
+## What changes
+
+## How it was checked
+
+<!-- Tests added or run; for behaviour a test cannot show, what you ran and what you saw. -->
+
+## Before review
+
+<!-- Delete the lines that do not apply. -->
+
+- [ ] Every commit is signed off (`git commit -s`)
+- [ ] `cargo fmt --all --check`, `cargo clippy --workspace --all-targets -- -D warnings` and `cargo test --workspace` pass
+- [ ] For changes under `web/`: `pnpm build` and `pnpm test` pass
+- [ ] SQL under `crates/utopia-store/` was tested with `UTOPIA_DATABASE_URL` set (those tests skip without it)
+- [ ] A new migration takes the next free number on `dev`, and `CURRENT_SCHEMA_VERSION` in `crates/utopia-cli/src/main.rs` equals the number of files in `migrations/`
+- [ ] UI strings are in both `web/src/i18n/en.ts` and `zh.ts`
+- [ ] A change to the data model, the ontology contract or a public API has its ADR in `docs/decisions/`
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 00000000..7f54ad34
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,85 @@
+# Contributor Covenant Code of Conduct
+
+[中文](CODE_OF_CONDUCT.zh-CN.md)
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **[email protected]**. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CODE_OF_CONDUCT.zh-CN.md b/CODE_OF_CONDUCT.zh-CN.md
new file mode 100644
index 00000000..fb987f50
--- /dev/null
+++ b/CODE_OF_CONDUCT.zh-CN.md
@@ -0,0 +1,87 @@
+# 贡献者公约
+
+[English](CODE_OF_CONDUCT.md)
+
+## 我们的承诺
+
+身为社区成员、贡献者和领袖,我们承诺使社区参与者不受骚扰,无论其年龄、体型、可见或不可见的缺陷、族裔、性征、性别认同和表达、经验水平、教育程度、社会与经济地位、国籍、相貌、种族、种姓、肤色、宗教信仰、性倾向或性取向如何。
+
+我们承诺以有助于建立开放、友善、多样化、包容、健康社区的方式行事和互动。
+
+## 我们的准则
+
+有助于为我们的社区创造积极环境的行为例子包括但不限于:
+
+* 表现出对他人的同情和善意
+* 尊重不同的主张、观点和感受
+* 提出和大方接受建设性意见
+* 承担责任并向受我们错误影响的人道歉
+* 注重社区共同诉求,而非个人得失
+
+不当行为例子包括:
+
+* 使用情色化的语言或图像,及性引诱或挑逗
+* 嘲弄、侮辱或诋毁性评论,以及人身或政治攻击
+* 公开或私下的骚扰行为
+* 未经他人明确许可,公布他人的私人信息,如物理或电子邮件地址
+* 其他有理由认定为违反职业操守的不当行为
+
+## 责任和权力
+
+社区领袖有责任解释和落实我们所认可的行为准则,并妥善公正地对他们认为不当、威胁、冒犯或有害的任何行为采取纠正措施。
+
+社区领导有权力和责任删除、编辑或拒绝与本行为准则不相符的评论(comment)、提交(commits)、代码、维基(wiki)编辑、议题(issues)或其他贡献,并在适当时告知采取措施的理由。
+
+## 适用范围
+
+本行为准则适用于所有社区场合,也适用于在公共场所代表社区时的个人。
+
+代表社区的情形包括使用官方电子邮件地址、通过官方社交媒体帐户发帖或在线上或线下活动中担任指定代表。
+
+## 监督
+
+辱骂、骚扰或其他不可接受的行为可通过 **[email protected]** 向负责监督的社区领袖报告。 所有投诉都将得到及时和公平的审查和调查。
+
+所有社区领袖都有义务尊重任何事件报告者的隐私和安全。
+
+## 处理方针
+
+社区领袖将遵循下列社区处理方针来明确他们所认定违反本行为准则的行为的处理方式:
+
+### 1. 纠正
+
+**社区影响**:使用不恰当的语言或其他在社区中被认定为不符合职业道德或不受欢迎的行为。
+
+**处理意见**:由社区领袖发出非公开的书面警告,明确说明违规行为的性质,并解释举止如何不妥。或将要求公开道歉。
+
+### 2. 警告
+
+**社区影响**:单个或一系列违规行为。
+
+**处理意见**:警告并对连续性行为进行处理。在指定时间内,不得与相关人员互动,包括主动与行为准则执行者互动。这包括避免在社区场所和外部渠道中的互动。违反这些条款可能会导致临时或永久封禁。
+
+### 3. 临时封禁
+
+**社区影响**: 严重违反社区准则,包括持续的不当行为。
+
+**处理意见**: 在指定时间内,暂时禁止与社区进行任何形式的互动或公开交流。在此期间,不得与相关人员进行公开或私下互动,包括主动与行为准则执行者互动。违反这些条款可能会导致永久封禁。
+
+### 4. 永久封禁
+
+**社区影响**:行为模式表现出违反社区准则,包括持续的不当行为、骚扰个人或攻击或贬低某个类别的个体。
+
+**处理意见**:永久禁止在社区内进行任何形式的公开互动。
+
+## 参见
+
+本行为准则改编自 [Contributor Covenant][homepage] 2.1 版, 参见 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]。
+
+社区处理方针灵感来源于 [Mozilla's code of conduct enforcement ladder][Mozilla CoC]。
+
+有关本行为准则的常见问题的答案,参见 [https://www.contributor-covenant.org/faq][FAQ]。 其他语言翻译参见 [https://www.contributor-covenant.org/translations][translations]。
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2c92e8e2..4152fd8b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
[中文](CONTRIBUTING.zh-CN.md)
-Welcome. This file covers what is specific to this repository; general open-source etiquette is assumed.
+Welcome. This file covers what is specific to this repository; general open-source etiquette is assumed. How we treat each other is in the [Code of Conduct](CODE_OF_CONDUCT.md).
## Branches and how changes land
diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md
index 95037569..0f9ce134 100644
--- a/CONTRIBUTING.zh-CN.md
+++ b/CONTRIBUTING.zh-CN.md
@@ -2,7 +2,7 @@
[English](CONTRIBUTING.md)
-欢迎。这份文件只写这个仓库特有的规矩 —— 通用的开源礼仪就不重复了。
+欢迎。这份文件只写这个仓库特有的规矩 —— 通用的开源礼仪就不重复了。彼此如何相处,见[行为准则](CODE_OF_CONDUCT.zh-CN.md)。
## 分支与合并流程