Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Improve guidance on interface documentation

未关闭
#812 0 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@RolandJentschETAS 已经在做这个了。

开始于 2026年10月6日。

评估

这个 Issue 还没有评估数据。

描述

What

ARC_02_04 has questions about error returns and input/output, this is currently unclear how to answer/resolve due to the "logical" nature of interface definitions. Interface definition expects currently only "General Interface Description" (https://eclipse-score.github.io/process_description/main/folder_templates/platform/features/feature_name/architecture/index.html#logical-interfaces). Need to define what should be described in IF definition.

Acceptance Criteria (DoD)
  • New process_description for architecture containing interface documentation guideline merged
  • Architecture example updated according to guideline
How

No response

主要语言
HTML
星标
6
派生
23
平均合并
11 小时 32 分钟
30 天内合并 PR
26

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

eclipse-score/process_description 的其他 Issue

查看 eclipse-score/process_description 的全部 Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。