You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2022/12/28 15:23:33 UTC
[logging-log4j2] branch switch-from-jira-to-github-issues created (now d2636406fe)
This is an automated email from the ASF dual-hosted git repository.
vy pushed a change to branch switch-from-jira-to-github-issues
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
at d2636406fe Switch from JIRA to GitHub Issues
This branch includes the following new commits:
new d2636406fe Switch from JIRA to GitHub Issues
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[logging-log4j2] 01/01: Switch from JIRA to GitHub Issues
Posted by vy...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch switch-from-jira-to-github-issues
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit d2636406fe0c3b44797e88efd4f9f3f7ffefe1c4
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Wed Dec 28 16:23:34 2022 +0100
Switch from JIRA to GitHub Issues
---
CONTRIBUTING.md | 9 ++-
README.md | 7 +-
pom.xml | 5 +-
.../1172_switch_from_jira_to_github_issues.xml | 22 ++++++
src/site/asciidoc/support.adoc | 81 ++++++++++++++++++++++
src/site/markdown/support.md | 51 --------------
src/site/site.xml | 1 -
src/site/xdoc/guidelines.xml | 21 +++---
8 files changed, 122 insertions(+), 75 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d0dd1135c4..0ac106eba9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,7 +26,6 @@ follow so that we can have a chance of keeping on top of things.
## Getting Started
-+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/join).
+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://logging.apache.org/log4j/2.x/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Log4j's scope.
+ Submit a ticket for your issue, assuming one does not already exist.
@@ -42,13 +41,13 @@ follow so that we can have a chance of keeping on top of things.
+ Only use spaces for indentation.
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+ Check for unnecessary whitespace with git diff --check before committing.
-+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
++ Make sure your commit messages are in the proper format. Your commit message should contain the associated issue ID.
+ Make sure you have added the necessary tests for your changes.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
## Making Trivial Changes
-For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
+For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
## Submitting Changes
@@ -56,13 +55,13 @@ In this case, it is appropriate to start the first line of a commit with '(doc)'
+ Sign the [Contributor License Agreement][cla] if you haven't already.
+ Push your changes to a topic branch in your fork of the repository.
+ Submit a pull request to the repository in the apache organization.
-+ Update your JIRA ticket and include a link to the pull request in the ticket.
++ Update your issue and include a link to the pull request in the ticket.
## Additional Resources
+ [Project Guidelines](https://logging.apache.org/log4j/2.x/guidelines.html)
+ [Code Style Guide](https://logging.apache.org/log4j/2.x/javastyle.html)
-+ [Apache Log4j 2 JIRA project page](https://issues.apache.org/jira/projects/LOG4J2/issues)
++ [Apache Log4j 2 Issue Tracker](https://github.com/apache/logging-log4j2/issues)
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://docs.github.com/)
+ [GitHub pull request documentation](https://docs.github.com/en/pull-requests)
diff --git a/README.md b/README.md
index 6fdaa2c654..c76e0ab5b4 100644
--- a/README.md
+++ b/README.md
@@ -103,11 +103,10 @@ see [Snapshot builds](https://logging.apache.org/log4j/2.x/maven-artifacts.html#
## Issue Tracking
-Issues, bugs, and feature requests should be submitted to the
-[JIRA issue tracking system for this project](https://issues.apache.org/jira/browse/LOG4J2).
+Issues, bugs, and feature requests should be submitted to
+[the issue tracker](https://github.com/apache/logging-log4j2/issues).
-Pull request on GitHub are welcome, but please open a ticket in the JIRA issue tracker first, and mention the
-JIRA issue in the Pull Request.
+Pull request on GitHub are welcome, but please open a ticket in the issue tracker first, and mention the issue in the Pull Request.
## Building From Source
diff --git a/pom.xml b/pom.xml
index 10829caa70..529c4a53a5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -36,14 +36,15 @@
<url>https://logging.apache.org/log4j/2.x/</url>
<issueManagement>
- <system>JIRA</system>
- <url>https://issues.apache.org/jira/browse/LOG4J2</url>
+ <system>GitHub Issues</system>
+ <url>https://github.com/apache/logging-log4j2/issues</url>
</issueManagement>
<ciManagement>
<system>GitHub Actions</system>
<url>https://github.com/apache/logging-log4j2/actions</url>
</ciManagement>
+
<inceptionYear>1999</inceptionYear>
<developers>
diff --git a/src/changelog/.2.x.x/1172_switch_from_jira_to_github_issues.xml b/src/changelog/.2.x.x/1172_switch_from_jira_to_github_issues.xml
new file mode 100644
index 0000000000..fa17bceb7b
--- /dev/null
+++ b/src/changelog/.2.x.x/1172_switch_from_jira_to_github_issues.xml
@@ -0,0 +1,22 @@
+<?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.
+-->
+<entry type="changed">
+ <issue id="1172" link="https://github.com/apache/logging-log4j2/pull/1172"/>
+ <author id="vy"/>
+ <description format="asciidoc">Switch the issue tracker from https://issues.apache.org/jira/browse/LOG4J2[JIRA] to https://github.com/apache/logging-log4j2/issues[GitHub Issues]</description>
+</entry>
diff --git a/src/site/asciidoc/support.adoc b/src/site/asciidoc/support.adoc
new file mode 100644
index 0000000000..6a58320398
--- /dev/null
+++ b/src/site/asciidoc/support.adoc
@@ -0,0 +1,81 @@
+////
+ 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.
+////
+
+= Support
+
+The Apache Software Foundation does not employ individuals to develop and support any of its projects.
+The individuals who contribute to Apache projects do it either as part of specific tasks assigned to them by their employer, on their own initiative to benefit their employer, or on their own free time.
+
+[#discussions]
+== Discussions
+
+Apache Log4j project officially uses following mailing lists for discussions:
+
+`log4j-user@logging.apache.org` (public | mailto:log4j-user-subscribe@logging.apache.org[subscribe] | mailto:log4j-user-unsubscribe@logging.apache.org[unsubscribe] | mailto:log4j-user@logging.apache.org[post] | https://lists.apache.org/list.html?log4j-user%40logging.apache.org[archive])::
+For _questions_ related to the usage of Log4j components
+
+`dev@logging.apache.org` (public | mailto:dev-subscribe@logging.apache.org[subscribe] | mailto:dev-unsubscribe@logging.apache.org[unsubscribe] | mailto:dev@logging.apache.org[post] | https://lists.apache.org/list.html?dev%40logging.apache.org[archive])::
+For _development_ discussions
+(Please prefix subjects with `[log4j]` when starting a new thread!)
+
+`security@logging.apache.org` (private | mailto:security@logging.apache.org[post])::
+For reporting unlisted security vulnerabilities or other unexpected behaviour that has a security impact
+
+`private@logging.apache.org` (private | mailto:private@logging.apache.org[post])::
+For the discussion of confidential topics within the Apache Logging Services project management committee
+
+You can alternatively post questions on Stack Overflow tagged with either http://stackoverflow.com/questions/tagged/log4j[log4j] or http://stackoverflow.com/questions/tagged/log4j2[log4j2].
+Note that *Stack Overflow is more casually monitored due to time constraints*.
+It is fine if you want to post first to Stack Overflow and then if you don't get an answer to post to the mailing lists.
+
+[#issues]
+== Issues
+
+The Log4j project uses https://github.com/apache/logging-log4j2/issues[GitHub Issues] as its issue tracking system.
+The old issue tracking system, https://issues.apache.org/jira/projects/LOG4J2[JIRA], is still accessible, though only recommended for issues that were already created there.
+
+Issues get resolved in one of the following ways:
+
+. The reporter or another interested party provides https://github.com/apache/logging-log4j2/pulls[a pull request] tagging the issue in its title
+. A committer is interested in the issue and decides to work on it
+. The reporter or another interested party sponsors one or more of xref:#sponsorship[the committers listed below] to encourage them to work on the issue
+
+Created issues are subject to the following policy:
+
+Quality::
+Issues posted of insufficient quality will be removed
+
+No protracted discussions::
+Issues likely to result in protracted discussion must be posted to the mailing lists
+
+No Questions::
+Do not post questions as issues!
+These will be removed, and you will be asked to post questions to the mailing lists instead.
+
+[#sponsorship]
+== Sponsorship
+
+Sponsorship can be used simply as a way to say thank you for the work that has been done or as a way to encourage specific issues to be worked on.
+In either case, while the Apache Logging Services project thanks you for your support, we cannot be responsible for any promises and/or contributions made by an individual committer, as individual commits must be reviewed and accepted by the project team.
+
+=== Committers accepting GitHub Sponsorship
+
+* https://github.com/garydgregory[Gary Gregory]
+* https://github.com/jvz[Matt Sicker]
+* https://github.com/rgoers[Ralph Goers]
+* https://github.com/vy[Volkan Yazıcı]
+* https://github.com/carterkozak[Carter Kozak]
diff --git a/src/site/markdown/support.md b/src/site/markdown/support.md
deleted file mode 100644
index 78024dd24f..0000000000
--- a/src/site/markdown/support.md
+++ /dev/null
@@ -1,51 +0,0 @@
-<!-- vim: set syn=markdown : -->
-<!--
- 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.
--->
-
-# Log4j Support
-
-The Apache Software Foundation does not employ individuals to develop and support any of its projects. The
-individuals who contribute to Apache projects do it either as part of specific tasks assigned to them by their
-employer, on their own initiative to benefit their employer, or on their own free time. While some projects
-at the ASF have employees who are specifically paid to work on the project, none of the committers to any
-of the Logging Services projects are directly paid to work on them.
-
-The Log4j project uses [Jira](https://issues.apache.org/jira/projects/LOG4J2) as its issue tracking system.
-Issues get resolved in one of the following ways:
-
-1. The reporter or another interested party provide a patch attached to the Jira issue, or (preferred) a pull request
-is provided at the [Log4j GitHub site](https://github.com/apache/logging-log4j2).
-2. A committer is interested in the issue and decides to work on it.
-3. The reporter or another interested party sponsors one or more of the people listed below to encourage them to
-work on the issue.
-
-## GitHub Sponsorship
-
-The following are Log4j committers who accept sponsorship through GitHub. GitHub sponsorship can be used simply as
-a way to say thank you for the work that has been done or as a way to encourage specific issues to be worked on. In either
-case, while the Apache Logging Services Project thanks you for your support we cannot be responsible for any
-promises and/or contributions made by an individual committer as individual commits must be reviewed and accepted
-by the project team. While the Logging Services team has accepted the individuals listed below as committers to the
-projects, we cannot recommend any particular individual for any specific issue.
-
-#### Committers who accept GitHub Sponsorship
-
-* [Gary Gregory](https://github.com/garydgregory)
-* [Matt Sicker](https://github.com/jvz)
-* [Ralph Goers](https://github.com/rgoers)
-* [Volkan Yazıcı](https://github.com/vy)
-* [Carter Kozak](https://github.com/carterkozak)
diff --git a/src/site/site.xml b/src/site/site.xml
index 6ced52576f..df560d8124 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -346,7 +346,6 @@
<menu name="Project Information" img="img/glyphicons/info.png">
<item name="Project Team" href="/team-list.html" />
- <item name="Mailing Lists" href="/mailing-lists.html" />
<item name="Issue Tracking" href="https://github.com/apache/logging-log4j2/issues" />
<item name="Project License" href="https://www.apache.org/licenses/LICENSE-2.0" />
<item name="Source Repository" href="https://github.com/apache/logging-log4j2" />
diff --git a/src/site/xdoc/guidelines.xml b/src/site/xdoc/guidelines.xml
index b1e69300c2..089c3e25d5 100644
--- a/src/site/xdoc/guidelines.xml
+++ b/src/site/xdoc/guidelines.xml
@@ -97,14 +97,11 @@
</subsection>
<a name="issues"/>
<subsection name="Issue Management">
- <p>The Log4j project uses the <a href="https://issues.apache.org/jira/browse/LOG4J2">Jira</a> bug tracking
- system hosted and maintained by the Apache Software Foundation for tracking bugs and enhancements. The
- project roadmap may be maintained in JIRA through its RoadMap feature and through the use of
- Story or Epic issues.</p>
+ <p>The Log4j project uses https://github.com/apache/logging-log4j2/issues[GitHub Issues] as its issue tracking system.</p>
<p>Many issues will be encountered by the project, each resulting in zero or
more proposed action items. Issues should be raised on the mailing list as
soon as they are identified. Action items <strong>must</strong> be raised on the mailing
- list and added to JIRA using the appropriate issue type. All action items may be voted
+ list and added to the issue tracker. All action items may be voted
on, but not all of them will require a formal vote.</p>
</subsection>
<a name="voting"/>
@@ -151,8 +148,8 @@
approval</em> until someone votes <strong>-1</strong> , after which point they are decided
by either consensus or a majority vote, depending upon the type of action
item.</p>
- <p>When appropriate, votes should be tallied in the JIRA issue. All votes must be either sent to
- the mailing list or added directly to the JIRA issue.</p>
+ <p>When appropriate, votes should be tallied in the issue tracker. All votes must be either sent to
+ the mailing list or added directly to the associated issue.</p>
</subsection>
<a name="types-of-action-items"/>
<subsection name="Types of Action Items">
@@ -183,9 +180,9 @@
Majority approval is required before the distribution can be publicly released.</dd>
<dt><strong>Showstoppers/Blockers</strong></dt>
<dd>Showstoppers are issues that require a fix be in place before the next
- public release. They are listed in Jira in order to focus
+ public release. They are listed in issue tracker in order to focus
special attention on the problem. An issue becomes a showstopper when
- it is listed as such in Jira and remains so by lazy consensus.</dd>
+ it is listed as such in the tracker and remains so by lazy consensus.</dd>
</dl>
<p>All product changes to the currently active repository are subject to lazy
consensus. All product changes to a prior-branch (old version) repository
@@ -202,7 +199,7 @@
size of the program, or changes the semantics of an existing API function
must receive consensus approval on the mailing list before being committed.</p>
<p>Each developer is responsible for notifying the mailing list and adding an
- action item to Jira when they have an idea for a new feature or major
+ action item to the issue tracker when they have an idea for a new feature or major
change to propose for the product. The distributed nature of the Log4j
project requires an advance notice of 48 hours in order to properly review
a major change -- consensus approval of either the concept or a specific
@@ -280,8 +277,8 @@ Reviewed by: susiecommitter
time of the commit, add later.)</p>
</li>
</ul>
- <p>All entries in changes.xml should include the appropriate Jira issue number and should
- credit contributions made by non-committers by referencing them in the due-to attribute
+ <p>All changelog entries should include the appropriate issue number and should
+ credit contributions made by non-committers by referencing them
even if modifications needed to be made to the contribution.</p>
<p>The attribution for the change is anyone responsible for the code changes.</p>
</subsection>