You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Everyone would also rather avoid maintaining them. What a hassle to have to evaluate what issues have been solved between two points in project's timeline, what types of problems they were, are they important to inform the users about, what issues solved them etc.
27
+
Everyone would also rather avoid maintaining them. What a hassle to have to evaluate what issues have been solved between two points in project's timeline, what types of problems they were, are they important to inform the users about, what issues solved them, etc.
28
28
29
-
Wouldn't it be great to get fantastic release notes compiled for you automaticaly based on all the hard work you put into your GitHub issues and pull requests.
29
+
Wouldn't it be great to get fantastic release notes compiled for you automatically based on all the hard work you put into your GitHub issues and pull requests?
30
30
31
-
The main motivation for bringing `gren` to life was the need for autogenerating release notes for every tag in a project.
32
-
The process, [as explained here](https://help.github.com/articles/creating-releases/), requires to go to your project's releases page in GitHub, draft that tag as a new release and manually add what I remembered has changed.
31
+
The main motivation for bringing `gren` to life was the need for auto-generating release notes for every tag in a project.
32
+
The process, [as explained here](https://help.github.com/articles/creating-releases/), requires the tagger to go to your project's releases page in GitHub, draft that tag as a new release and manually add what has changed.
33
33
34
34
Let `gren` take care of that for you. It automates this process and also writes release notes for you, creating something like this:
35
35
@@ -68,7 +68,7 @@ If you want to be more accurate on the issues that belong to a release, you can
68
68
69
69
#### Help 🤖 to write wondeful stuff (issues)
70
70
71
-
In order to have spliendid generated release notes, we reccomend to follow these convensions:
71
+
In order to have splendidly generated release notes, we recommend to follow these conventions:
72
72
73
73
1. Start the title with a verb (e.g. Change header styles)
74
74
2. Use the imperative mood in the title (e.g. Fix, not Fixed or Fixes header styles)
@@ -77,9 +77,9 @@ In order to have spliendid generated release notes, we reccomend to follow these
77
77
### `commits`
78
78
79
79
The simplest way of getting data is from the commits you write.
80
-
Even though it doesn't require a machine-readable commit, still would be better to have them in a nice format.
80
+
Even though it doesn't require a machine-readable commit, it is still better to have them in a nice format.
81
81
82
-
The output would then use commit messages (title + description) to look something like:
82
+
The output then uses commit messages (title + description) to look something like:
83
83
84
84
> ## v0.9.0 (17/05/2017)
85
85
>
@@ -93,7 +93,7 @@ The output would then use commit messages (title + description) to look somethin
93
93
94
94
#### Help 🤖 to write wondeful stuff (commits)
95
95
96
-
In order to have spliendid generated release notes, we reccomend to follow these convensions:
96
+
In order to have splendidly generated release notes, we recommend to follow these conventions:
97
97
98
98
1. Start the subject line with a verb (e.g. Change header styles)
99
99
2. Use the imperative mood in the subject line (e.g. Fix, not Fixed or Fixes header styles)
@@ -194,7 +194,7 @@ gren examples release
194
194
195
195
## Configuration file
196
196
197
-
You can create a configuration file where the task will be ran, where to specify your options. [See how to set up the config file](https://github-tools.github.io/github-release-notes/options.html#configuration-file)
197
+
You can create a configuration file where the task will be run to specify your options. [See how to set up the config file](https://github-tools.github.io/github-release-notes/options.html#configuration-file)
0 commit comments