From 01e3e7917c3cfc92f74688d97db7f089d8c67ccd Mon Sep 17 00:00:00 2001 From: kulesy Date: Thu, 1 Oct 2026 11:24:50 +1000 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D=20Retire=20the=20stale=20contr?= =?UTF-8?q?ibution=20set-up=20page=20and=20point=20the=20guidelines=20at?= =?UTF-8?q?=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5.5 --- content/docs-zh/contributing/setting-up.mdx | 52 -------------- content/docs/contributing/guidelines.mdx | 76 ++++++++++----------- content/docs/contributing/setting-up.mdx | 52 -------------- content/settings/config.json | 11 +++ 4 files changed, 48 insertions(+), 143 deletions(-) delete mode 100644 content/docs-zh/contributing/setting-up.mdx delete mode 100644 content/docs/contributing/setting-up.mdx diff --git a/content/docs-zh/contributing/setting-up.mdx b/content/docs-zh/contributing/setting-up.mdx deleted file mode 100644 index d7f8c25c..00000000 --- a/content/docs-zh/contributing/setting-up.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: 贡献设置 -last_edited: '2021-02-18T13:05:33.946Z' ---- - - - 此页面已过时 - 请查看 [TinaCMS GitHub](https://github.com/tinacms/tinacms/blob/main/CONTRIBUTING.md) 以获取最新的贡献信息 - } -/> - -## 开发 - -要开始： - -```bash -git clone https://github.com/tinacms/tinacms.git -cd tinacms -npm install -npm run bootstrap -npm run build - -# 启动 Gatsby 演示 -cd packages/demo-gatsby -npm run start -``` - -**不要在** `packages` 目录中运行 `npm install` - -> **TinaCMS** 使用 **[Lerna](https://lerna.js.org/)** 来管理本地开发时的依赖。这允许各个包通过符号链接相互引用。在包内运行 `npm install` 会用 npm 注册表中的包引用替换符号链接。 - -## 命令 - -| 命令 | 描述 | -| ----------------------------------- | --------------------------------------------- | -| `npm run bootstrap` | 安装依赖并链接本地包。 | -| `npm run build` | 构建所有包 | -| `npm run test` | 为所有包运行测试 | -| `lerna run build --scope ` | 仅构建 ``。 | -| `lerna run watch` | 监视所有包以进行重建。 | - -## 运行开发包 - -安装开发设置后，您可以运行 *packages* 目录中的演示应用程序 **demo-cra**、**demo-gatsby** 和 **demo-next**。 - -这些项目可以用作 TinaCMS 包的开发环境，您可以编辑 TinaCMS 包中的任何其他包。 - -在编辑 tina 的包时，我们可以执行命令 `npm run dev` 来在仓库包上执行开发构建。 - -此命令将构建所有 TinaCMS 包。这将在 tina 演示包的引用中反映，从而根据所做的更改更新演示包。 - -这样，您可以更改 tinacms 包并在演示包中测试更改，作为开发环境。 diff --git a/content/docs/contributing/guidelines.mdx b/content/docs/contributing/guidelines.mdx index a237bdda..c50d9544 100644 --- a/content/docs/contributing/guidelines.mdx +++ b/content/docs/contributing/guidelines.mdx @@ -1,44 +1,42 @@ --- title: Contribution Guidelines +last_edited: '2026-10-01T01:30:00.000Z' +tocIsHidden: true --- - - This page is out of date - check out [the TinaCMS GitHub](https://github.com/tinacms/tinacms/blob/main/CONTRIBUTING.md) for the latest contribution information - } +TinaCMS is built in the open on GitHub, and contributions of every size are welcome. The setup steps and PR workflow live next to the code in the TinaCMS repo, so they stay in step with the tooling. + + - -The following is a set of guidelines and tips for contributing to the TinaCMS and its packages. Please also reference this [doc](https://github.com/tinacms/tinacms/blob/master/CONTRIBUTING.md) for the latest info on contributing. - -**If you have questions or need help, please post it on the** **[Forum](https://tina.io/community/).** - -## How to Contribute - -* [Reporting Bugs](https://github.com/tinacms/tinacms/issues) -* [Suggesting Enhancements](https://github.com/tinacms/tinacms/issues) -* [Writing Docs, Guides, or Blog Posts](https://github.com/tinacms/tina.io) -* Volunteering for User Testing -* [Adding features, fixing bugs etc.](https://github.com/tinacms/tinacms/issues) -* [Answer questions in the TinaCMS Forum](https://tina.io/community/) -* Tackle a [good-first-issue](https://github.com/tinacms/tinacms/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)! - -## Contributing Code - -Read the [set-up](/docs/contributing/setting-up) guide to get started developing on TinaCMS locally. - -### Making Commits - -TinaCMS uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) to generate CHANGELOG entries. Please make sure your commits follow this convention. - -### Creating Packages - -Packages in TinaCMS are organized according to their name - -| Type | Naming Convention | Example Path | -| ----------------------- | ------------------ | ----------------------- | -| Internal packages | `@tinacms/*` | `@tinacms/core` | -| Node API extensions | `@tinacms/api-*` | `@tinacms/api-git` | -| React specific packages | `react-tinacms-*` | `react-tinacms-remark` | -| Gatsby plugins | `gatsby-tinacms-*` | `gatsby-tinacms-json` | -| NextJS package | `next-tinacms-*` | `next-tinacms-markdown` | -| Demo Projects | `demo-*` | `demo-gatsby` | diff --git a/content/docs/contributing/setting-up.mdx b/content/docs/contributing/setting-up.mdx deleted file mode 100644 index 388937e4..00000000 --- a/content/docs/contributing/setting-up.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Contribution Set-up -last_edited: '2021-02-18T13:05:33.946Z' ---- - - - This page is out of date - check out [the TinaCMS GitHub](https://github.com/tinacms/tinacms/blob/main/CONTRIBUTING.md) for the latest contribution information - } -/> - -## Development - -To get started: - -```bash -git clone https://github.com/tinacms/tinacms.git -cd tinacms -npm install -npm run bootstrap -npm run build - -# Start the Gatsby demo -cd packages/demo-gatsby -npm run start -``` - -**Do not run** `npm install` from inside the `packages` directory - -> **TinaCMS** uses **[Lerna](https://lerna.js.org/)** to manage dependencies when developing locally. This allows the various packages to reference each other via symlinks. Running `npm install` from within a package replaces the symlinks with references to the packages in the npm registry. - -## Commands - -| Commands | Description | -| ----------------------------------- | --------------------------------------------- | -| `npm run bootstrap` | Install dependencies and link local packages. | -| `npm run build` | Build all packages | -| `npm run test` | Run tests for all packages | -| `lerna run build --scope ` | Build only ``. | -| `lerna run watch` | Watch all packages for rebuilds. | - -## Run Development Packages - -After installing the development setup you can run demo applications contained in the *packages* directory **demo-cra**, **demo-gatsby** and **demo-next**. - -These projects can be used as a development environment for TinaCMS packages, you can edit any other package contained within TinaCMS packages. - -When editing the packages of tina we can execute the command `npm run dev` to execute an development build on the repository packages. - -This command will build all TinaCMS packages. This will reflect in the references of the tina demo packages, thus updating the demo packages according to the changes made. - -This way you can change the tinacms packages and test the changes in the demo packages as a development environment. diff --git a/content/settings/config.json b/content/settings/config.json index 376b69a4..10b0f982 100644 --- a/content/settings/config.json +++ b/content/settings/config.json @@ -487,6 +487,17 @@ "source": "/search", "destination": "/reference/search/overview", "permanent": false + }, + { + "source": "/contributing/setting-up", + "destination": "/contributing/guidelines", + "permanent": true + }, + { + "source": "/docs/zh/contributing/setting-up", + "destination": "/zh/docs/contributing/guidelines", + "permanent": true, + "basePath": false } ], "title": "TinaCMS", From 1ce757cfa69db9534141f18caf7d43e68fe29868 Mon Sep 17 00:00:00 2001 From: kulesy Date: Thu, 1 Oct 2026 14:11:18 +1000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=8C=90=20Translate=20the=20new=20cont?= =?UTF-8?q?ribution=20guidelines=20into=20Chinese=20by=20hand,=20since=20t?= =?UTF-8?q?he=20auto-translate=20workflow=20is=20failing?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5.5 --- content/docs-zh/contributing/guidelines.mdx | 76 ++++++++++----------- 1 file changed, 37 insertions(+), 39 deletions(-) diff --git a/content/docs-zh/contributing/guidelines.mdx b/content/docs-zh/contributing/guidelines.mdx index 3e51e21a..bf608294 100644 --- a/content/docs-zh/contributing/guidelines.mdx +++ b/content/docs-zh/contributing/guidelines.mdx @@ -1,44 +1,42 @@ --- title: 贡献指南 +last_edited: '2026-10-01T01:30:00.000Z' +tocIsHidden: true --- - - 此页面已过时 - 请查看 [TinaCMS GitHub](https://github.com/tinacms/tinacms/blob/main/CONTRIBUTING.md) 以获取最新的贡献信息 - } +TinaCMS在GitHub上公开开发，欢迎任何规模的贡献。环境设置步骤和PR流程与代码一起放在TinaCMS仓库中，因此会与工具链保持同步。 + + - -以下是一组为TinaCMS及其包贡献的指南和提示。请同时参考此[文档](https://github.com/tinacms/tinacms/blob/master/CONTRIBUTING.md)以获取最新的贡献信息。 - -**如果您有问题或需要帮助，请在** **[论坛](https://tina.io/community/)** **上发布。** - -## 如何贡献 - -* [报告错误](https://github.com/tinacms/tinacms/issues) -* [建议增强功能](https://github.com/tinacms/tinacms/issues) -* [撰写文档、指南或博客文章](https://github.com/tinacms/tina.io) -* 自愿参与用户测试 -* [添加功能、修复错误等](https://github.com/tinacms/tinacms/issues) -* [在TinaCMS论坛回答问题](https://tina.io/community/) -* 解决一个[良好的入门问题](https://github.com/tinacms/tinacms/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)! - -## 贡献代码 - -阅读[设置](/docs/contributing/setting-up)指南以开始在本地开发TinaCMS。 - -### 提交更改 - -TinaCMS使用[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)来生成变更日志条目。请确保您的提交遵循此约定。 - -### 创建包 - -TinaCMS中的包根据其名称进行组织 - -| 类型 | 命名约定 | 示例路径 | -| ----------------------- | ------------------ | ----------------------- | -| 内部包 | `@tinacms/*` | `@tinacms/core` | -| Node API扩展 | `@tinacms/api-*` | `@tinacms/api-git` | -| React特定包 | `react-tinacms-*` | `react-tinacms-remark` | -| Gatsby插件 | `gatsby-tinacms-*` | `gatsby-tinacms-json` | -| NextJS包 | `next-tinacms-*` | `next-tinacms-markdown` | -| 演示项目 | `demo-*` | `demo-gatsby` |