Opened 9 years ago

Closed 6 years ago

#1222 defect closed fixed (fixed)

Document branch development policy

Reported by: hypatia Owned by:
Priority: high Milestone:
Component: core Keywords: documentation, review
Cc: glyph, radix, exarkun, spiv, itamarst, jml Branch: branches/dev-docs-1222
(diff, github, buildbot, log)
Author: exarkun Launchpad Bug:

Description


Change History (17)

comment:1 Changed 9 years ago by hypatia

As per
http://twistedmatrix.com/pipermail/twisted-python/2005-September/011531.html
major feature development is now meant to occur in branches. Neither the coding
standard nor the svn standard seem to talk about this, and perhaps it should be
in a third policy document anywhere. Where's the original announcement of this
policy? That might be sufficient for documenting this.

comment:2 Changed 9 years ago by hypatia

for "it should be in a third policy document anywhere" read "it should be in a
third policy document anyway"

comment:3 Changed 9 years ago by jml

There has been some discussion in the past 
- http://thread.gmane.org/gmane.comp.python.twisted/427
- http://thread.gmane.org/gmane.comp.python.twisted/8802

Not sure how useful it is.

comment:4 Changed 9 years ago by jml

I suggest that we adopt a modified version of Divmod's branching policy, found
at http://divmod.org/trac/wiki/BranchBasedDevelopment and
http://divmod.org/trac/wiki/MergedForward.  

Suggested changes:
- "all development" should be changed to "all major development". 
- Issue tracker details should be modified appropriately.
- SVN instructions added
- The "Merged Forward" instructions should be supplemented with instructions for
people who don't use Combinator. 
- Some tips for reviewing
- Notes on using the buildbot to run the test suite over the branch.

If y'all are fine with this, then I'll be happy to knock up a draft.

comment:5 Changed 9 years ago by jml

I am a procrastitron.
http://twistedmatrix.com/trac/twisted/wiki/BranchPolicy

comment:6 Changed 9 years ago by glyph

I actually think that we should adopt an *un*modified version of that branch
policy :).  I have been meaning to roll Combinator into Twisted one of these
days when I have some spare time.

In particular, I want to suggest that the Combinator commands (mkbranch,
chbranch, unbranch) be left as the default way of fulfilling the policy, because
I have loads of experience at this point which suggests that attempting to do
things like merging to trunk without any automation *WILL* result in corrupted
or lost branches, or lost changes within a branch during a merge.

The tools could also probably be improved by integration with Twisted; right now
they are in a weird limbo of dependencies, since you use Combinator to install
Twisted after you install Divmod.  It would make a lot more sense to use
Combinator to install Divmod after you install Twisted.

comment:7 Changed 9 years ago by jml

Well, if it's that dangerous, should we give up on using branches until you get
around to merging Combinator?

comment:8 Changed 9 years ago by glyph

Anyone else who wants to merge Combinator may do so.  It shouldn't be too much
work, a matter of changing a few paths around and such.

comment:9 Changed 8 years ago by hypatia

  • Component set to conch

Filing "merge Combinator" separately.

comment:10 Changed 8 years ago by hypatia

  • Cc hypatia removed
  • Owner changed from hypatia to edsuom

Filed as Ticket #1697. To fix *this* bug, the branch policy should be linked from the Lore development howtos as well as from the website.

comment:11 Changed 8 years ago by exarkun

  • Component changed from conch to core

comment:12 Changed 6 years ago by exarkun

  • author set to exarkun
  • Branch set to branches/dev-docs-1222

(In [23958]) Branching to 'dev-docs-1222'

comment:13 Changed 6 years ago by exarkun

(In [23959]) a lot of fixes for extremely obsolete information, plus a mention of Combinator and UQDS

refs #1222

comment:14 Changed 6 years ago by exarkun

  • Keywords review added
  • Owner edsuom deleted

I made some changes to svn-dev. Can anything think of anything else that would be useful?

jml, thanks for writing BranchPolicy way back then. I don't think we need it anymore, though. Any thoughts on that?

comment:15 Changed 6 years ago by jml

I think you're right.

I took a look at [23959] and couldn't see anything obvious to change. If you want to merge the branch as-is then you have my review stamp.

comment:16 Changed 6 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [23974]) Merge dev-docs-1222

Author: exarkun
Reviewer: jml
Fixes: #1222

Update some of the documentation targetted at developers to remove
obsolete information (such as references to CVS and unused tools),
point out UQDS and where to learn more about it, and note that the
Debian packages can no longer be built with our toolchain.

comment:17 Changed 3 years ago by <automation>

Note: See TracTickets for help on using tickets.