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

Custom fields

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

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

检查教程结构以及现有的 project.json 和 projects.json 引用。决定这部分关于 raw、enriched 和 configuration-injected 字段的说明最适合放在哪里,然后将其整合到教程的相关内容中。完成的标准是:说明已放置在相关章节中,并且其术语和文件引用保持一致。

由索引模型根据 Issue 内容生成。

描述

Just wanted to save this explanation. Not sure of where in the tutorial to insert it:

The fields in GrimoireLab come to be through different paths:

  • Most are just retrieved from the data sources. We call this data raw data.
  • The enrichment process that runs after the data load (usually called by Morderd for similar) adds more standard-calculated fields. We call this data enriched data.
  • Then, the user can inject fields via configuration (instead of retrieving them directly or indirectly from the sources). We can call these configuration-injected fields "tags".

Currently, all tags are defined via the project.json file).

Some tags have standard field names. The user only injects their arbitrary values.
Some other tags are user-defined fields. The user injects both their values and the name of these fields.

Grimoirelab can inject user-defined data through at least 3 paths:

  • The project field. It holds the name of the projects. Their values (project names) and their applicabilities (which data source belongs to each project) are defined in the projects.json file.
  • The meta member of each project (set in the projects.json file).
    • It generates the cm_* fields we find in every item retrieved from sources (commits, issues, PRs, repos, areas_of_code, ...) attributed to that project.
    • All these project-level custom fields are marked with a cm_ appendix. So, if you ask for a my_tag field in the meta member of a project you get a cm_my_tag field.
  • A standard field called labels.
    • It is a list of values.
    • We can inject a user-defined list of values per repository.
    • This, again, propagates to many items retrieved from sources (commits, issues, PRs, repos, areas_of_code, ...) attributed to that repository.
主要语言
Ruby
星标
30
派生
67
PR 合并指标
30 天内没有已合并 PR

环境准备

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

从这里开始

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

chaoss/grimoirelab-tutorial 的其他 Issue

查看 chaoss/grimoirelab-tutorial 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

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