github-changelog-generator/github-changelog-generator

[doc] Add Case Studies/Use-cases section, with examples from real-world usage

Open

#693 建立於 2018年11月19日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Ruby (7,523 star) (846 fork)batch import
documentationhacktoberfesthelp wanted

描述

This Issue is a call for documentation additions about how people have used this tool.

Here's how one Node.js software project uses this tool to "improve release process":

https://github.com/davewasmer/ember-cli-favicon/commit/08be5a5a105bbeef359a5e252d2ace0a1334411e

Detail:

  • a gcg config file with a single option
  • a config file for ember-cli-release to call the tool

貢獻者指南

技術棧
ruby
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
familiarity with GitHub changelog generatormarkdown writing skills
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
Review the existing README and documentation to identify where to add a 'Case Studies' section. Use the linked commit (08be5a5a105bbeef359a5e252d2ace0a1334411e) as an example of real world usage. Gather additional examples from the repository's issue tracker or community. Propose a new section with brief descriptions and links to projects using the tool.