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 2023/01/22 19:16:14 UTC
[logging-log4j2] 01/01: Switch from JIRA to GitHub Issues
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch jira-to-github-3.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit da947b0302b10da47daee5af81b34f919b0a0521
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Mon Jan 16 19:57:52 2023 +0100
Switch from JIRA to GitHub Issues
---
CONTRIBUTING.md | 9 ++--
README.md | 5 +--
pom.xml | 4 +-
src/site/asciidoc/guidelines.adoc | 22 +++------
src/site/asciidoc/support.adoc | 94 ++++++++++++++++++++++++++-------------
5 files changed, 78 insertions(+), 56 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 1e039dd07e..83534e3430 100644
--- a/README.md
+++ b/README.md
@@ -103,10 +103,9 @@ 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).
+[the issue tracking system for this project](https://github.com/apache/logging-log4j2/issues).
-Pull requests 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 requests 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 8e09dc5aec..282c6638ba 100644
--- a/pom.xml
+++ b/pom.xml
@@ -35,8 +35,8 @@
<description>Apache Log4j 2</description>
<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>
diff --git a/src/site/asciidoc/guidelines.adoc b/src/site/asciidoc/guidelines.adoc
index 813f1570e5..22a4c581c7 100644
--- a/src/site/asciidoc/guidelines.adoc
+++ b/src/site/asciidoc/guidelines.adoc
@@ -97,16 +97,12 @@ access].
[#issues]
== Issue Management
-The Log4j project uses the
-https://issues.apache.org/JIRA/browse/LOG4J2[JIRA] 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.
+The Log4j project uses https://github.com/apache/logging-log4j2/issues[GitHub Issues] for its issue tracking system.
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 *must* be raised on
-the mailing list and added to JIRA using the appropriate issue type. All
+the mailing list and added to the issue tracker using the appropriate issue type. All
action items may be voted on, but not all of them will require a formal
vote.
@@ -159,10 +155,6 @@ approval_ until someone votes *-1* , after which point they are decided
by either consensus or a majority vote, depending upon the type of
action item.
-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.
-
[#types-of-action-items]
== Types of Action Items
@@ -193,9 +185,9 @@ to the public. Majority approval is required before the distribution
can be publicly released.
Showstoppers/Blockers::
Showstoppers are issues that require a fix be in place before the next
-public release. They are listed in JIRA in order to focus special
+public release. They are listed in the issue tracking system 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.
+listed as such in the issue tracking system and remains so by lazy consensus.
All product changes to the currently active repository are subject to
lazy consensus. All product changes to a prior-branch (old version)
@@ -215,7 +207,7 @@ function must receive consensus approval on the mailing list before
being committed.
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
+an action item to the issue tracking system 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
@@ -298,8 +290,8 @@ now fixed
* all security fixes included, with CVE number. (If not available at the
time of the commit, add later.)
-All entries in changelog should include the appropriate JIRA issue
-number and should credit contributions made by non-committers by
+All entries in changelog should include the appropriate issue
+ID and should credit contributions made by non-committers by
referencing them in the due-to attribute even if modifications needed to
be made to the contribution.
diff --git a/src/site/asciidoc/support.adoc b/src/site/asciidoc/support.adoc
index 035764e617..3ffeb1b8a8 100644
--- a/src/site/asciidoc/support.adoc
+++ b/src/site/asciidoc/support.adoc
@@ -15,48 +15,80 @@
limitations under the License.
////
-= Log4j Support
+= 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 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.
-The Log4j project uses https://issues.apache.org/jira/projects/LOG4J2[Jira] 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 https://github.com/apache/logging-log4j2[Log4j GitHub site].
-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.
+. 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.
-== GitHub Sponsorship
+[#sponsorship]
+== 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.
+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 who accept GitHub Sponsorship
+=== Committers accepting 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)
-* [Piotr P. Karwasz](https://github.com/ppkarwasz)
+* 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]
-## Third-party commercial support
+[#commercial]
+== Third-party commercial support
-While neither the Apache Software Foundation nor the Apache Logging Services project provide any commercial support for
-the Log4j products, individual committers may collaborate with services that provide such support.
+While neither the Apache Software Foundation nor the Apache Logging Services project provide any commercial support for the Log4j products, individual committers may collaborate with services that provide such support.
The following aims to be a list of all commercial support services involving one or more Log4j committers.
-### Tidelift
+[#tidelift]
+=== Tidelift
-Some Log4j maintainers receive funding from Tidelift for their maintenance efforts. See [the Tidelift website](https://tidelift.com) for details.
+Some Log4j maintainers receive funding from Tidelift for their maintenance efforts.
+See https://tidelift.com[the Tidelift website] for details.