Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

pr-template: instruction about updating changelog #1205

Merged
merged 2 commits into from
Oct 4, 2017
Merged

pr-template: instruction about updating changelog #1205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76d8676
pr-template: instruction about updating changelog
darkowlzz Sep 22, 2017
2e51ae2
changelog: correct changelog about ensure
darkowlzz Sep 22, 2017
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
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!--
Work-in-progress PRs are welcome as a way to get early feedback - just prefix
the title with [WIP].

Add the change in the changelog (except for test changes and docs updates).
Please edit CHANGELOG.md and add the change under the appropriate category (NEW
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the changelog currently only has IMPROVEMENTS, not all three of these. seems to me like KISS would dictate that we just have IMPROVEMENTS and BUG FIXES as sections, but if you're modeling this after some other changelog that seems particularly effective, i'm happy to defer.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we would have new features when the new status is implemented. So, we can use NEW FEATURES then. Let's keep it 🙂

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what rule would you apply to distinguish between an improvement and a feature?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NEW FEATURE = new subcommands, flags, importer support
IMPROVEMENTS = enhancement on existing features and behavior

I see NEW FEATURE as a special section that would be at the top, which could be used to highlight important changes that affect the users. This could be a new way to do something, support for something new or a breaking change to some existing behavior. And IMPROVEMENTS for the rest of the things, that a normal user need not care much.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i still think we'll have some difficulty cleanly applying that rule to cleanly delineate between the two, but as long as we're looking at "NEW FEATURE" as a special section that we use to highlight things, i think it's probably OK.

FEATURES, IMPROVEMENTS & BUG FIXES) along with the PR number.
-->

### What does this do / why do we need it?
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ IMPROVEMENTS:
* File name case check is now performed on `Gopkg.toml` and `Gopkg.lock`.
(#1114)
* gps: gps now supports pruning. (#1020)
* `dep ensure -add` now concurrently validates the passed project arguments.
Improving performance when adding new dependencies with `-add`. (#1175)
* `dep ensure -update` now concurrently validates the passed project arguments.
Improving performance when updating dependencies with `-update`. (#1175)
* `dep status` now concurrently fetches repo info. Improving status performance.
(#1135)

Expand Down