亚马逊AWS官方博客

OpenSource | Style Dictionary 的维护人员首次参与 Hacktoberfest

Style Dictionary 的维护人员今年第一次参与了 Hacktoberfest,这真是一个奇妙的体验。虽然我们的数字看似不大,但让新的贡献者参与项目并启动我们已经积压很久的工作,真正令人振奋。参与此活动的最大收获之一就是在项目中看到许多新视角,让我们能够了解项目和文档中的哪些部分令人混淆或遗漏。此外,这也让我们拥有了通过其他渠道无法获得的新贡献者和用户。这对还没有庞大社区的小项目而言尤为宝贵。

下面是明年我们将汲取的一些经验教训:

  1. 做好更充分准备。 我们在一开始就跳上了 Hacktoberfest 列车,但没有从“好的第一个问题”列表中抽取出经过修整的问题列表,这导致我们面临了一些障碍。明年我们将在九月份开始准备问题列表。
  2. 每天预留时间。 尽管规模相对较小,在每天开始时花 30 分钟浏览新的 Pull 请求或问题将大有裨益。
  3. 清理分支。 在一些问题上我们不得不修改 Pull 请求的分支,与更长期运行的分支出现一些冲突。明年我们希望能制定更好的分支策略,包含发布新版本的 CI/CD。
  4. 明确需求,提供示例。 最成功的问题是包含非常明确的示例的问题。由于无法预期新来者会项目背后的内部工作机制或原理,如果您可以指出一些例子或提供非常明确的指令,将很有帮助。

Hacktoberfest 期间的活动简介

  • 打开的 Pull 请求数:27
  • 关闭的 Pull 请求数:24
  • 打开的问题数:21
  • 关闭的问题数:21(与打开的问题数相同纯属巧合)
  • 贡献者:8

我们的成绩

  • 启动开发 Style Dictionary 的下一个重要发布 3.0 版
    • 使用更好、更新的 eslint 和 ES6 语法更新了代码
  • 迁移到 Jest 并为 Style Dictionary 生成的文件添加快照测试,从而升级测试
    • 从 191 项测试增加到 226 项测试和 29 个快照
  • 增加新的内置格式
  • 增加 JSON5 支持
  • 增加模块和格式配置,从而不包含生成的备注和编译日期
  • 修复文档站点的一些样式漏洞
  • 修复循环引用的一个漏洞
  • 显著改进我们的错误消息收发和控制台输出。不再局限在一个参考错误,而收集所有错误并一次显示,从而让您无需修复一个错误,重新构建,然后再重复。
  • 启动模板的反对路径。并未取消权力,您仍可以使用格式模板。我们同时拥有模板和格式,这令人混淆,因此这一调整在没有取消任何功能的前提下简化了 API。

感谢所有贡献者的辛勤付出! 我们将借此东风继续努力编好 Style Dictionary,期待明年 Hacktoberfest 见。