blob: 6d07f57b234b18e8c21b52127705e6a08e4c8388 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Subversion Best Practices</title>
</header>
<body>
<fixme author="">
This doc is under development. It should have general notes to assist all
developers to use the latest code in Forrest SVN and tips for working with
SVN. An extra section would have other tips specific for Forrest
committers. Some tips should instead be added to the ASF-wide docs, where
we can link to them.
</fixme>
<section id="goldenRules">
<title>Golden Rules</title>
<p>
Using subversion seems so easy. But there are so many things you can do
to mess up other peoples work. This document tries to name just a few:
</p>
<ul>
<li>Be familiar with the <a href="site:version-control">instructions</a> for using Forrest SVN.
</li>
<li>See ASF-wide notes for <a href="http://www.apache.org/dev/#svn">developers</a>.
</li>
<li>Use the <a href="http://svnbook.red-bean.com/">SVN Book</a> - Version Control with Subversion.
</li>
<li><a href="contrib.html#svn-config">Configure</a> your svn client.
<fixme author="">
Move the notes from contrib.html to here. See other notes in
<a href="http://marc.theaimsgroup.com/?t=114834506800002">email</a>.
</fixme></li>
<li>When moving an existing file please use "svn move fromFile toFile". This ensures
that the history of the item is not lost.</li>
</ul>
</section>
</body>
</document>