Skip to content

Correct misspelled words and improve formatting #199

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.

Sign up for GitHub

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

Merged
alexcanessa merged 1 commit into from
Jan 8, 2019
Merged

Correct misspelled words and improve formatting #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/concept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ If you want to be more accurate on the issues that belong to a release, you can

> The output above is a result of release notes built from issues.

#### Help 🤖 to write wondeful stuff (issues)
#### Help 🤖 to write wonderful stuff (issues)

In order to have spliendid generated release notes, we reccomend to follow these convensions:
In order to have splendidly generated release notes, we reccomend to follow these convensions:

1. Start the title with a verb (e.g. Change header styles)
1. Start the title with a verb (e.g. **Change** header styles)
2. Use the imperative mood in the title (e.g. Fix, not Fixed or Fixes header styles)
3. Use labels wisely and assign one label per issue. `gren` has the [option to ignore issues](https://github-tools.github.io/github-release-notes/options.html#ignore-issues-with) that have a one of the specified labels.
3. Use labels wisely and assign one label per issue. `gren` has the [option to ignore issues](https://github-tools.github.io/github-release-notes/options.html#ignore-issues-with) that have more than one of the specified labels.

### `commits`

Expand All @@ -87,9 +87,9 @@ The output would then use commit messages (title + description) to look somethin

#### Help 🤖 to write wondeful stuff (commits)

In order to have spliendid generated release notes, we reccomend to follow these convensions:
In order to have splendidly generated release notes, we reccomend to follow these convensions:

1. Start the subject line with a verb (e.g. Change header styles)
1. Start the subject line with a verb (e.g. **Change** header styles)
2. Use the imperative mood in the subject line (e.g. Fix, not Fixed or Fixes header styles)
3. Limit the subject line to about 50 characters
4. Do not end the subject line with a period
Expand Down