Skip to content

Commit aed5a1a

Browse files
blairg23alexcanessa
authored andcommitted
Updated README.md (#226)
Grammatical and spelling fixes.
1 parent 739c67d commit aed5a1a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ It also can generate a `CHANGELOG.md` file based on the release notes (or genera
2424
## The Motivation and Concept
2525

2626
Everyone loves neat, transparent, informative release notes.
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.
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.
2828

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?
3030

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 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.
3333

3434
Let `gren` take care of that for you. It automates this process and also writes release notes for you, creating something like this:
3535

@@ -68,7 +68,7 @@ If you want to be more accurate on the issues that belong to a release, you can
6868
6969
#### Help 🤖 to write wondeful stuff (issues)
7070

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:
7272

7373
1. Start the title with a verb (e.g. Change header styles)
7474
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
7777
### `commits`
7878

7979
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.
8181

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:
8383

8484
> ## v0.9.0 (17/05/2017)
8585
>
@@ -93,7 +93,7 @@ The output would then use commit messages (title + description) to look somethin
9393
9494
#### Help 🤖 to write wondeful stuff (commits)
9595

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:
9797

9898
1. Start the subject line with a verb (e.g. Change header styles)
9999
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
194194

195195
## Configuration file
196196

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)
198198
The accepted file extensions are the following:
199199

200200
- `.grenrc`

0 commit comments

Comments
 (0)