Skip to content

Commit

Permalink
Polish
Browse files Browse the repository at this point in the history
  • Loading branch information
snicoll committed Jan 13, 2024
1 parent 5f16ee7 commit 3e01a00
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you want to use milestone ID, you should set the `changelog.milestone-referen


=== Customizing Sections
By default the changelog will contain the following sections:
By default, the changelog will contain the following sections:

|===
|Title |Label Text
Expand Down Expand Up @@ -123,7 +123,7 @@ An issue labeled with `new` and `noteworthy` will appear in both the "Highlights


=== Excluding Issues
Issues and pull requests can be excluded from the changlog by configuring exclusions.
Issues and pull requests can be excluded from the changelog by configuring exclusions.
You can ignore all items that have certain labels using `changelog.issues.exclude.labels`.
For example:

Expand Down Expand Up @@ -153,7 +153,7 @@ You can also use `*` if you want to drop the contributors section entirely.


=== Sorting Issues
By default issues are sorted by their "created" date.
By default, issues are sorted by their "created" date.
If you want to order them by title instead you can set `changelog.issues.sort` to `title`.
It's also set the property on section configuration if you want ordering per section:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import io.spring.githubchangeloggenerator.github.service.Repository;

/**
* Configuration properties for the Github repo.
* Configuration properties for the GitHub repo.
*
* @author Madhura Bhave
* @author Phillip Webb
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2018-2022 the original author or authors.
* Copyright 2018-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -21,7 +21,7 @@
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Details of a Github user.
* Details of a GitHub user.
*
* @author Madhura Bhave
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import org.springframework.util.StringUtils;

/**
* Github related properties.
* GitHub related properties.
*
* @author Phillip Webb
* @author Madhura Bhave
Expand All @@ -35,12 +35,12 @@ public class GitHubProperties {
private final String apiUrl;

/**
* The username for the github user.
* The username for the GitHub user.
*/
private final String username;

/**
* The password for the github user.
* The password for the GitHub user.
*/
private final String password;

Expand Down

0 comments on commit 3e01a00

Please sign in to comment.