Opened 3 years ago

Closed 3 years ago

#20932 closed enhancement (fixed)

Coding Standards: No changes file for bug fix on unreleased code

Reported by: jryans Owned by: jryans
Priority: Medium Milestone: Tor: 0.3.0.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: doc
Cc: jryans Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

While reviewing #20572, dgoulet said that a changes file is not used when fixing something that has not been released.

That's not stated in the CodingStandards.md yet, so it would help new contributors to clarify this.

Child Tickets

Change History (8)

comment:1 Changed 3 years ago by jryans

Owner: set to jryans
Status: newassigned

comment:2 Changed 3 years ago by jryans

Status: assignedneeds_review

comment:3 Changed 3 years ago by teor

Keywords: doc added
Milestone: Tor: 0.3.0.x-final
Status: needs_reviewneeds_revision

Oh, really?
I thought we used them, but deleted them when we compiled the ChangeLog.
(You can't always tell if the thing you are fixing will be released without the patch you just made.)

So I think we should modify the CodingStandards, but explain how it actually works in practice.

comment:4 Changed 3 years ago by jryans

I am happy to document the current practice once there's some agreement on what it is. :)

comment:5 Changed 3 years ago by dgoulet

Cc: dgoulet removed
Status: needs_revisionneeds_information

FYI, I've never done changes file for bugfixes of unreleased code. Maybe I should have? nickm can clarify this but from my perspective the changes file are useful for the ChangeLog so there is not need to document a fix on a feature that was never released else we would do change file for basically every commit.

That said, I believe the patch here is accurate and mergeable.

I'll put this one in needs_information and direct it to nickm.

comment:6 Changed 3 years ago by nickm

Right; the changes files are for the changelog. Things go into the changelog only if they are a change since some previous release of the code.

comment:7 Changed 3 years ago by dgoulet

Status: needs_informationmerge_ready

comment:8 Changed 3 years ago by nickm

Resolution: fixed
Status: merge_readyclosed

Merged!

Note: See TracTickets for help on using tickets.