Skip to content

Expand changelog documentation with more detail #6980

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
aduth merged 2 commits into from
Sep 16, 2022
Merged

Expand changelog documentation with more detail #6980

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92ae726
Expand changelog documentation with more detail
aduth Sep 16, 2022
567bd9b
Add example for subcategory
aduth Sep 16, 2022
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
25 changes: 20 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,27 @@ Database Cleaner to ignore those static tables.
changelog: Internal, Automated Testing, Improve performance of test suite
```

Choose from one of the following changelog categories:
#### Changelog Messages

- **Improvements** are user-facing improvements to the application experience, such as a new UI component or updated text.
- **Bug Fixes** are corrections to a broken behavior, such as preventing a raised exception.
- **Internal** are changes which benefit the Login.gov team, such as analytics or code quality.
- **Upcoming Features** are iterations contributing to a feature which has not yet been enabled for users in production.
You must include a changelog message in one commit of your pull request.

A changelog message should be written in the following format:

```
changelog: [Category], [Subcategory], [Description]
```

Replace `[Category]`, `[Subcategory]`, and `[Description]` with text relevant for your changes:

- **Category** must be one of the following:
- **Improvements** are user-facing improvements to the application experience, such as a new UI component or updated text.
- **Bug Fixes** are corrections to a broken behavior, such as preventing a raised exception.
- **Internal** are changes which benefit the Login.gov team, such as analytics or code quality.
- **Upcoming Features** are iterations contributing to a feature which has not yet been enabled for users in production.
- **Subcategory** does not have any restrictions, but you should try to maintain consistency with changesets affecting similar parts of the application (for example, "In-person proofing").
- **Description** is a plain language description of the specific changes.

If multiple pull requests iterate on the same feature, it's a good idea to use the same commit message, since identical messages will be combined into a single entry when the release notes are compiled.

### Additional notes on pull requests and code reviews

Expand Down