Author: vsiveton
Date: Thu Jul 3 13:38:11 2008
New Revision: 673793
URL: http://svn.apache.org/viewvc?rev=673793&view=rev
Log:
o improved developers conventions
Added:
maven/site/trunk/src/site/apt/developers/conventions/jira.apt (with props)
maven/site/trunk/src/site/apt/developers/conventions/svn.apt (with props)
Modified:
maven/site/trunk/src/site/apt/developers/index.apt
maven/site/trunk/src/site/apt/guides/development/guide-helping.apt
maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
Added: maven/site/trunk/src/site/apt/developers/conventions/jira.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/conventions/jira.apt?rev=673793&view=auto
==============================================================================
--- maven/site/trunk/src/site/apt/developers/conventions/jira.apt (added)
+++ maven/site/trunk/src/site/apt/developers/conventions/jira.apt Thu Jul 3
13:38:11 2008
@@ -0,0 +1,78 @@
+ ------
+ Maven Jira Convention
+ ------
+ Vincent Siveton
+ ------
+ 2008-07-03
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Maven Jira Convention
+
+ This document describes how Maven developers should use Jira, our issue
tracking.
+
+* Issue Details
+
+** Priority
+
+ Committers has the responsibility to realign priority by editing the issue.
+
+ <<Reasoning>>: having a correct release note.
+
+** Assignee
+
+ Committers could assign an issue to a specific committer if he thinks it is
the right committer.
+
+** Component/s
+
+ Committers has the responsibility to specify the correct the component by
editing the issue.
+
+ <<Reasoning>>: having a correct release note.
+
+** Affects Version/s
+
+ By default, the Maven team considers that an issue, which affects a given
version, affects also precedent versions, i.e. issue
+ which affects Maven 2.0.9 will affect also 2.0, 2.0.1 ... 2.0.9.
+ If it is a regression, the committers should specify the affected versions.
+
+ <<Reasoning>>: having a correct release note.
+
+** Fix Version/s
+
+ TO BE DISCUSSED
+
+~~ Since the Maven team works on the trunk (2.1) and the main branch (2.0.x),
the committers should always mark issues that are both 2.0.x and 2.1.
+~~ Reasoning: it's good housekeeping to always say both to keep track of the
changes in both branches.
+
+** Time Tracking
+
+ The Maven team never uses it. Committers could do it, but like said, it will
never be used.
+
+* Further Links
+
+ * {{{http://www.atlassian.com/software/jira/docs/latest/}JIRA Documentation}}
+
+ * {{{http://www.atlassian.com/software/jira/docs/latest/issues.html}What is
an Issue?}}
+
+ * {{{http://www.atlassian.com/software/jira/docs/latest/projects.html}What is
a project?}}
+
+ []
Propchange: maven/site/trunk/src/site/apt/developers/conventions/jira.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/site/trunk/src/site/apt/developers/conventions/jira.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: maven/site/trunk/src/site/apt/developers/conventions/svn.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/conventions/svn.apt?rev=673793&view=auto
==============================================================================
--- maven/site/trunk/src/site/apt/developers/conventions/svn.apt (added)
+++ maven/site/trunk/src/site/apt/developers/conventions/svn.apt Thu Jul 3
13:38:11 2008
@@ -0,0 +1,84 @@
+ ------
+ Maven SVN Convention
+ ------
+ Vincent Siveton
+ ------
+ 2008-07-03
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Maven SVN Convention
+
+ This document describes how developers should use SVN, our SCM.
+
+* Subversion Configuration
+
+ Before committing files in subversion repository, you need to read the
+ {{{http://www.apache.org/dev/version-control.html#https-svn}Committer
Subversion Access}}
+ document and you must set your svn client with this properties file :
+ {{{../../developers/svn-eol-style.txt}svn-eol-style.txt}}
+
+* {Commit Message Template}
+
+ Commits should have a message that follows this template:
+
++-----+
+[issue1, issue2] <<comment>>
+Submitted by: (when it was a patch, put that persons name there)
+
+o some comments
++-----+
+
+ Where:
+
+ * <<issue>> can be omitted if there was no relevant JIRA issue, though it is
strongly encouraged to create one for
+ significant changes.
+
+ * <<Submitted by>> only needs to be specified when a patch is being applied
for a non-committer.
+
+ * <<comments>> some words about the commits.
+
+ []
+
+eg:
+
++-----+
+[MNG-1456] Added the foo to the bar
+Submitted by: Baz Bazman
+
+o applied without change
++-----+
+
+* Apply User Patch
+
+ By default, the committer should apply the patch without any <<major>>
modifications. In a second step, the committer
+ could apply any changes as usual.
+
+* Edit Commit Message
+
+ If you want to edit a commit message, you could call:
+
++-----+
+svn pe svn:log --revprop -r XXX
++-----+
+
+ where <<XXX>> is the wanted version
Propchange: maven/site/trunk/src/site/apt/developers/conventions/svn.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/site/trunk/src/site/apt/developers/conventions/svn.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/site/trunk/src/site/apt/developers/index.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/index.apt?rev=673793&r1=673792&r2=673793&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/index.apt (original)
+++ maven/site/trunk/src/site/apt/developers/index.apt Thu Jul 3 13:38:11 2008
@@ -4,7 +4,7 @@
Vincent Siveton
Brett Porter
------
- July 2008
+ 2008-07-03
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -65,6 +65,10 @@
* {{{./conventions/code.html}Maven Code Style And Convention}}
+ * {{{./conventions/jira.html}Maven Jira Convention}}
+
+ * {{{./conventions/svn.html}Maven SVN Convention}}
+
[]
<<Note>>: If you cannot find your answers here, feel free to ask the
{{{mailto:[EMAIL PROTECTED] Developer List}}.
Modified: maven/site/trunk/src/site/apt/guides/development/guide-helping.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-helping.apt?rev=673793&r1=673792&r2=673793&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/development/guide-helping.apt
(original)
+++ maven/site/trunk/src/site/apt/guides/development/guide-helping.apt Thu Jul
3 13:38:11 2008
@@ -82,7 +82,9 @@
* {{{../../developers/conventions/code.html}Maven Code Style And Convention}}
- * {{{./guide-m2-development.html#Commit_Message_Template} Commit Message
Template}}
+ * {{{../../developers/conventions/jira.html}Maven Jira Convention}}
+
+ * {{{../../developers/conventions/svn.html}Maven SVN Convention}}
[]
Modified:
maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt?rev=673793&r1=673792&r2=673793&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
(original)
+++ maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
Thu Jul 3 13:38:11 2008
@@ -217,29 +217,12 @@
Maven Wagon is also a standalone API that deals with transporting files and
directories. Maven Core uses the Wagon
API to download and upload artifacts and artifact metadata and the site
plug-in uses it to publish the site.
-* Subversion Configuration
+* Further Links
- Before committing files in subversion repository, you need to read the
- {{{http://www.apache.org/dev/version-control.html#https-svn}Committer
Subversion Access}}
- document and you must set your svn client with this properties file :
{{{../../developers/svn-eol-style.txt}svn-eol-style.txt}}
+ * {{{../../developers/code.html}Maven Code Style And Code Convention}}
-* {Commit Message Template}
+ * {{{../../developers/jira.html}Maven Jira Convention}}
- Commits should have a message that follows this template:
+ * {{{../../developers/svn.html}Maven SVN Convention}}
------
-[issue1, issue2] <<comment>>
-Submitted by: (when it was a patch, put that persons name there)
------
-
- <<issue>> can be omitted if there was no relevant JIRA issue, though it is
strongly encouraged to create one for significant
- changes.
-
- <<Submitted by>> only needs to be specified when a patch is being applied
for a non-committer.
-
-eg:
-
------
-[MNG-1456] Added the foo to the bar
-Submitted by: Baz Bazman
------
+ []
