Applio Website

VC/VC++ 2025-07-31

Applio Website S(monorepo)

  1. monorepo结构

    • MonorePo包含多个项目。每个项目都位于apps目录下的各自目录中。
  2. 代码审查

    • 所有更改都必须经过代码审核过程。完成功能或BugFix完成时,请向main分支打开拉动请求(PR)。
    • 公关标题应遵循该格式: [Project] Short description of the change
    • 提供有关PR的变化的详细说明,包括要解决的问题和任何相关上下文。

提交消息指南

  1. 格式

    • 使用以下格式进行提交消息:
       [project]: Short description of the change
      
      Detailed explanation (if necessary)
      
    • 例子:
       docs: Add new section to documentation
      
      The new section includes detailed instructions on setting up the development environment. Adjusted the formatting to ensure consistency.
      
  2. 范围

    • 清楚地指定您通过使用项目标识符(例如, applio-docsapplio-org等)来贡献的项目。
    • 如果更改会影响多个项目,请列出所有相关的项目标识符。
  3. 消息内容

    • 简短的描述应该简洁而描述。
    • 如有必要,详细的解释应提供额外的上下文,包括变更背后的推理和任何潜在影响。

TurborePo使用

  1. 运行任务

    • 使用TurborePo有效地跨项目运行任务。
    • 常见任务包括:
      • pnpm run build以构建所有项目。
      • pnpm run dev以开发模式启动所有项目。
      • pnpm run biome:format以格式化所有代码。
  2. 特定于项目的命令

    • 您可以使用项目标识符来运行特定项目的任务:
      • pnpm run build --filter=applio-docs
      • pnpm run test --filter=applio-org

贡献工作流程

  1. 克隆存储库

    • 克隆MonorePo到您的本地机器:
      git clone https://g*ithub**.com/IAHispano/Applio-Website.git
      cd Applio-Website
  2. 设置环境

    • 使用PNPM安装依赖项:
      pnpm install
  3. 创建一个新分支

    • 为您的功能或BugFix创建一个新分支:
      git checkout -b feature/applio-docs-new-section
  4. 进行更改

    • 在适当的项目目录( apps/applio-docsapps/applio-org )中进行更改。
    • 根据提交消息指南提交您的更改。
  5. 推动变化并创建PR

    • 将您的分支推到遥控存储库:
      git push origin feature/applio-docs-new-section
    • 在Github上创建PR,并要求您的团队成员进行审查。
  6. 合并

    • PR批准并通过所有检查通过后,您可以将其合并到main分支中。

运行特定于项目的命令

  • 要运行项目的特定命令(例如, applio-docs ),请使用以下内容:
    pnpm i --filter=applio-docs
    pnpm run dev --filter=applio-docs

最佳实践

  • 编写干净,可维护和有据可查的代码。
  • 遵循每个项目特定的编码标准和指南。
  • 在提交公关之前,请确保所有测试通过。
  • 定期从main分支中提取最新更改,以使您的分支保持最新。
  • 通过向同行提供建设性的反馈来参与代码审查。

示例项目命令

设置并运行文档项目( applio-docs ):

  1. 克隆存储库:

    git clone https://*git*hub.*com/IAHispano/Applio-Website
    cd Applio-Website
  2. 安装applio-docs依赖性:

    pnpm i --filter=applio-docs
  3. 运行applio-docs的开发服务器:

    pnpm run dev --filter=applio-docs

接触

如果您有任何疑问或需要进一步的帮助,请随时与存储库维护者联系或在Github上打开问题。

感谢您为Applio Website的Monorepo做出贡献!您的努力有助于我们制造出色的产品。

下载源码

通过命令行克隆项目:

git clone https://github.com/IAHispano/Applio-Website.git