Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note
titleNote

This document is a work in progress

This document is intended to capture some of the policies we would like all committers to follow when it comes to checking in changes into our SVN tree.

Commit Log Format

No Format
Wiki Markup
{note:title=Note}
This document is a work in progress
{note}

This document is intended to capture some of the policies we would like all committers to follow when it comes to checking in changes into our {SVN tree|http://svn.apache.org/viewvc/trafficserver/traffic/}.

h2. Commit Log Format

{noformat}
TS-#### short summary (50 chars or less), not a sentence

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.
{noformat}

h2. Trunk

Trunk is CTR, [

Trunk

Trunk is CTR, Commit-Then-Review

...

,

...

policy.

...

This

...

was

...

discussed

...

and

...

voted

...

on

...

by

...

the

...

community

...

a

...

long

...

time

...

ago.

...

This

...

does

...

grant

...

a

...

lof

...

of

...

freedom

...

to

...

committing

...

experimental

...

or

...

unstable

...

code

...

to

...

the

...

trunk.

...

However,

...

with

...

such

...

powers,

...

comes

...

some

...

responsibilities:

...

  1. You

...

  1. are

...

  1. responsible

...

  1. for

...

  1. latest

...

  1. trunk

...

  1. to

...

  1. build

...

  1. and

...

  1. at

...

  1. least

...

  1. start

...

  1. up

...

  1. with

...

  1. your

...

  1. changes

...

  1. before

...

  1. you

...

  1. commit

...

  1. to

...

  1. SVN.

...

  1. This

...

  1. typically

...

  1. implies

...

  1. that

...

  1. you

...

  1. ought

...

  1. to

...

  1. do

...

  1. an

...

  1. `svn

...

  1. up`

...

  1. to

...

  1. your

...

  1. tree

...

  1. and

...

  1. build

...

  1. before

...

  1. committing.

...

  1. Of

...

  1. course,

...

  1. we

...

  1. don't

...

  1. expect

...

  1. everyone

...

  1. to

...

  1. test

...

  1. on

...

  1. more

...

  1. than

...

  1. their

...

  1. preferred

...

  1. development

...

  1. platform(s),

...

  1. and

...

  1. we'll

...

  1. work

...

  1. with

...

  1. the

...

  1. Infraops

...

  1. team

...

  1. to

...

  1. increase

...

  1. our

...

  1. coverage

...

  1. with

...

  1. continuous

...

  1. integration

...

  1. tools

...

  1. and

...

  1. build-bots.

...

  1. At

...

  1. a

...

  1. minimum

...

  1. the

...

  1. the

...

  1. build

...

  1. should

...

  1. not

...

  1. break

...

  1. on

...

  1. the

...

  1. current

...

  1. primary

...

  1. buildbot

...

  1. slave

...

  1. which

...

  1. is

...

  1. http://ci.apache.org/buildslaves/bb-vm_ubuntu

...

  1. Image Added (Ubuntu

...

  1. Linux).

...

  1. If

...

  1. the

...

  1. primary

...

  1. build

...

  1. bot

...

  1. is

...

  1. broken

...

  1. it

...

  1. is

...

  1. the

...

  1. commiter's

...

  1. responsibility

...

  1. to

...

  1. get

...

  1. the

...

  1. build

...

  1. working

...

  1. or

...

  1. find

...

  1. someone

...

  1. to

...

  1. help

...

  1. them.

...

  1. If

...

  1. the

...

  1. trunk

...

  1. is

...

  1. broken,

...

  1. i.e.

...

  1. it

...

  1. doesn't

...

  1. build

...

  1. and/or

...

  1. run

...

  1. even

...

  1. without

...

  1. your

...

  1. changes,

...

  1. please

...

  1. don't

...

  1. commit

...

  1. !

...

  1. Meaning,

...

  1. please

...

  1. don't

...

  1. pour

...

  1. more

...

  1. fuel

...

  1. on

...

  1. the

...

  1. fire.

...

  1. If

...

  1. your

...

  1. changes

...

  1. result

...

  1. in

...

  1. a

...

  1. non-functioning

...

  1. Traffic

...

  1. Server

...

  1. (e.g.

...

  1. start

...

  1. fails,

...

  1. simple

...

  1. forward

...

  1. proxy

...

  1. browsing

...

  1. is

...

  1. broken,

...

  1. etc)

...

  1. please

...

  1. consider

...

  1. backing

...

  1. out

...

  1. your

...

  1. changes

...

  1. and

...

  1. submitting

...

  1. the

...

  1. changes

...

  1. for

...

  1. review

...

  1. under

...

  1. a

...

  1. new

...

  1. TS

...

  1. Jira

...

  1. ticket

...

  1. and

...

  1. asking

...

  1. for

...

  1. reviewers.

...

  1. If

...

  1. your

...

  1. changes

...

  1. are

...

  1. so

...

  1. large

...

  1. that

...

  1. you

...

  1. want

...

  1. to

...

  1. make

...

  1. partial

...

  1. commits,

...

  1. create

...

  1. a

...

  1. SVN

...

  1. branch

...

  1. or

...

  1. work

...

  1. on

...

  1. a

...

  1. local

...

  1. repository

...

  1. using

...

  1. a

...

  1. version

...

  1. control

...

  1. system

...

  1. like

...

  1. Git

...

  1. or

...

  1. Mercurial.

...

  1. Several

...

  1. of

...

  1. the

...

  1. developers

...

  1. in

...

  1. the

...

  1. community

...

  1. use

...

  1. Git

...

  1. and

...

  1. hg,

...

  1. and

...

  1. can

...

  1. provide

...

  1. help

...

  1. and

...

  1. tips

...

  1. on

...

  1. how

...

  1. to

...

  1. use

...

  1. it.

...

Release

...

branches

...

All

...

release

...

branches

...

(e.g.

...

2.0.x)

...

should

...

always

...

be

...

kept

...

in

...

a

...

stable

...

and

...

functional

...

state.

...

The

...

commit

...

policy

...

is

...

RTC,

...

Review

...

Then

...

Commit

...

,

...

and

...

backporting

...

changes

...

from

...

trunk

...

should

...

be

...

voted

...

on

...

via

...

the

...

STATUS

...

file

...

on

...

the

...

respective

...

branches.