You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2020/01/07 23:46:18 UTC
[maven-site] branch master updated: Fix publishing errors (and
convert to MD)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new ae1d140 Fix publishing errors (and convert to MD)
ae1d140 is described below
commit ae1d14033e283273fe0eb7df43a7f928b4416fec
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Wed Jan 8 00:45:47 2020 +0100
Fix publishing errors (and convert to MD)
---
content/apt/developers/conventions/jira.apt | 90 -------------------------
content/markdown/developers/conventions/jira.md | 76 +++++++++++++++++++++
2 files changed, 76 insertions(+), 90 deletions(-)
diff --git a/content/apt/developers/conventions/jira.apt b/content/apt/developers/conventions/jira.apt
deleted file mode 100644
index 558a78c..0000000
--- a/content/apt/developers/conventions/jira.apt
+++ /dev/null
@@ -1,90 +0,0 @@
-------
-Maven JIRA Conventions
-------
-Vincent Siveton
-------
-2008-07-05
-------
-
-~~ 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:
-~~ https://maven.apache.org/doxia/references/apt-format.html
-
-Maven JIRA Convention
-
-This document describes how Maven developers should use JIRA, our issue management system.
-
-* When To Create a JIRA Issue?
-
-This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).
-
-* <<Minor changes>> such as code reformatting, documentation fixes, etc. that aren't going to impact other users
-can be committed without a JIRA issue.
-
-* <<Larger changes>> such as bug fixes, API changes, significant refactoring, new classes, and pretty much any change
-of more than 100 lines, should have JIRA tickets.
-Creating a JIRA issue and referring it in the commit comments simplifies tracking the changes that happen in a release,
-using JIRA automatic release notes creation.
-
-[]
-
-* How To Use Issue Details?
-
-This section presents some conventions about the issue fields.
-
-** Priority
-
-Committers have the responsibility to realign priority by editing the issue.
-
-<<Reasoning>>: having a correct release note.
-
-** Assignee
-
-Committers can assign an issue to a specific committer that person seems to
-be well placed to address it.
-
-** Component/s
-
-Committers have the responsibility to specify the correct 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 also affects preceding versions. For example, an issue
-that affects Maven 2.0.9 also affects 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
-
-** Time Tracking
-
-The Maven team doesn't use this. Committers can if it helps them.
-
-* Further Links
-
-* {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA Documentation}}
-
-* {{{https://www.atlassian.com/software/jira/docs/latest/issues.html}What is an Issue?}}
-
-* {{{https://www.atlassian.com/software/jira/docs/latest/projects.html}What is a project?}}
-
-[]
diff --git a/content/markdown/developers/conventions/jira.md b/content/markdown/developers/conventions/jira.md
new file mode 100644
index 0000000..30f7ea1
--- /dev/null
+++ b/content/markdown/developers/conventions/jira.md
@@ -0,0 +1,76 @@
+## Maven JIRA Conventions
+<!--
+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.
+-->
+This document describes how Maven developers should use JIRA, our issue management system.
+
+### When To Create a JIRA Issue?
+
+This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).
+
+- **Minor changes** such as code reformatting, documentation fixes, etc. that aren't going to impact other users
+can be committed without a JIRA issue.
+
+- **Larger changes** such as bug fixes, API changes, significant refactoring, new classes, and pretty much any change
+of more than 100 lines, should have JIRA tickets.
+
+Creating a JIRA issue and referring it in the commit comments simplifies tracking the changes that happen in a release,
+using JIRA automatic release notes creation.
+
+### How To Use Issue Details?
+
+This section presents some conventions about the issue fields.
+
+#### Priority
+
+Committers have the responsibility to realign priority by editing the issue.
+
+*Reasoning*: having a correct release note
+
+#### Assignee
+
+Committers can assign an issue to a specific committer that person seems to
+be well placed to address it.
+
+#### Component/s
+
+Committers have the responsibility to specify the correct 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 also affects preceding versions. For example, an issue
+that affects Maven 3.6.3 also affects 3.6.0, 3.6.1, 3.6.2.
+If it is a regression, the committers should specify the affected versions.
+
+*Reasoning*: having a correct release note.
+
+#### Fix Version/s
+
+Update to correct version after merging to master.
+
+#### Time Tracking
+
+The Maven team doesn't use this. Committers can if it helps them.
+
+### Further Links
+
+- [JIRA Documentation](https://confluence.atlassian.com/jira064/jira-documentation-720411693.html)
+- [What is an Issue?](https://confluence.atlassian.com/jira064/what-is-an-issue-720416138.html)
+- [What is a project?](https://confluence.atlassian.com/jira064/what-is-a-project-720416135.html)
\ No newline at end of file