-
-
Notifications
You must be signed in to change notification settings - Fork 849
[DOC] Explain new Labels and Summary Section support in README #678
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
As a draft: Examples of usage of summary sectionFor each version, you can add a release summary with text, images, gif animation, etc., and show new features and notes clearly to the user.
|
Thanks, this is a good start, would you begin a PR with that content? (I can't copy-and-paste the raw Markdown from here.) |
Actually, I can see the raw Markdown! |
- fixes #678 - thanks so much for authoring the example, @mob-sakai
Thanks for your PR! |
You're awesome, guys! 🎉 |
I was trying to use it, but it is not working. Can you share a project that uses it? abntex/limarka#171 - this issue doest't generate it. The changelog without the summary:
|
Hi @edusantana
Use
|
As you see here a use it like this: Gem::Specification.new do |spec|
#...
spec.add_development_dependency "github_changelog_generator"
#...
end My workaround was to use it at the Gemfile as well, but I don't like it. At what version this summary option was added? |
1.15.0, but it has not been released yet. |
Update README.md
See #654
The text was updated successfully, but these errors were encountered: