diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 22d84a5..a261465 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:contributing-md |
+ | 1) Re-generate using: mvn commons-build:contributing-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.jira.id (required, alphabetic, upper case) |
@@ -51,47 +51,65 @@ Getting Started
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/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 Commons Logging's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
+ Clearly describe the issue including steps to reproduce when it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
++ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
+[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
Making Changes
--------------
-+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
++ Create a _topic branch_ for your isolated work.
+ * Usually you should base your branch on the `master` branch.
+ * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `LOGGING-123-InputStream`.
+ * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
+ Make commits of logical units.
+ * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
+ * e.g. `LOGGING-123: Close input stream earlier`
+ Respect the original code style:
+ 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 you have added the necessary tests for your changes.
+ + 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 first.
+ + Check for unnecessary whitespace with `git diff` -- check before committing.
++ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
Making Trivial Changes
----------------------
+The JIRA tickets are used to generate the changelog for the next release.
+
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
+
Submitting Changes
------------------
-+ Sign the [Contributor License Agreement][cla] if you haven't already.
++ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already.
+ * Note that small patches & typical bug fixes do not require a CLA as
+ clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
+ covers them.
+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a pull request to the repository in the apache organization.
++ Submit a _Pull Request_ to the corresponding repository in the `apache` organization.
+ * Verify _Files Changed_ shows only your intended changes and does not
+ include additional files like `target/*.class`
+ Update your JIRA ticket and include a link to the pull request in the ticket.
+If you prefer to not use GitHub, then you can instead use
+`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
+
+
Additional Resources
--------------------
+ [Contributing patches](https://commons.apache.org/patches.html)
-+ [Apache Commons Logging JIRA project page](https://issues.apache.org/jira/browse/LOGGING)
++ [Apache Commons Logging JIRA project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
-+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
++ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.net`
[cla]:https://www.apache.org/licenses/#clas
+[jira]:https://issues.apache.org/jira/browse/LOGGING
diff --git a/NOTICE.txt b/NOTICE.txt
index 53257af..67d7715 100644
--- a/NOTICE.txt
+++ b/NOTICE.txt
@@ -1,6 +1,5 @@
Apache Commons Logging
-Copyright 2003-2023 The Apache Software Foundation
+Copyright 2001-2023 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (https://www.apache.org/).
-
diff --git a/README.md b/README.md
index caad61a..de5a25f 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 1) Re-generate using: mvn commons-build:readme-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
@@ -42,40 +42,53 @@
--->
Apache Commons Logging
===================
-[](https://github.com/apache/commons-logging/actions/workflows/maven.yml)
-[](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/?gav=true)
-[](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml)
-Apache Commons Logging is a thin adapter allowing configurable bridging to other, well known logging systems.
+[](https://github.com/apache/commons-logging/actions/workflows/maven.yml)
+[](https://app.codecov.io/gh/apache/commons-logging)
+[](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/?gav=true)
+[](https://javadoc.io/doc/commons-logging/commons-logging/1.3.0)
+[](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml)
+[](https://api.securityscorecards.dev/projects/github.com/apache/commons-logging)
+
+Apache Commons Logging is a thin adapter allowing configurable bridging to other,
+ well known logging systems.
Documentation
-------------
More information can be found on the [Apache Commons Logging homepage](https://commons.apache.org/proper/commons-logging).
-The [Javadoc](https://commons.apache.org/proper/commons-logging/javadocs/api-release) can be browsed.
+The [Javadoc](https://commons.apache.org/proper/commons-logging/apidocs) can be browsed.
Questions related to the usage of Apache Commons Logging should be posted to the [user mailing list][ml].
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-logging/download_logging.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
We recommend you use a mirror to download our release
- builds, but you must verify the integrity of
+ builds, but you must verify the integrity of
the downloaded files using signatures downloaded from our main
distribution directories. Recent releases (48 hours) may not yet
- be available from the mirrors.
+ be available from all the mirrors.
@@ -88,39 +101,44 @@ limitations under the License.
- The KEYS
- link links to the code signing keys used to sign the product.
- The
+ The KEYS
+ file contains the public PGP keys used by Apache Commons developers
+ to sign releases.
PGP link downloads the OpenPGP compatible signature from our main site.
- The MD5 link downloads the checksum from the main site.
+ It is essential that you
+ verify the integrity
+ of downloaded files, preferably using the PGP signature (*.asc files);
+ failing that using the SHA512 hash (*.sha512 checksum files).
+
-
commons-logging-1.2-bin.tar.gz
- md5
- pgp
+ commons-logging-1.3.0-bin.tar.gz
+ sha512
+ pgp
-
commons-logging-1.2-bin.zip
- md5
- pgp
+ commons-logging-1.3.0-bin.zip
+ sha512
+ pgp
-
commons-logging-1.2-src.tar.gz
- md5
- pgp
+ commons-logging-1.3.0-src.tar.gz
+ sha512
+ pgp
-
commons-logging-1.2-src.zip
- md5
- pgp
+ commons-logging-1.3.0-src.zip
+ sha512
+ pgp
- Commons Logging uses ASF JIRA for tracking issues. - See the Commons Logging JIRA project page. + Apache Commons Logging uses ASF JIRA for tracking issues. + See the Apache Commons Logging JIRA project page.
- To use JIRA you may need to create an account + To use JIRA you may need to create an account (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically - created and you can use the Forgot Password + created and you can use the Forgot Password page to get a new password).
If you would like to report a bug, or raise an enhancement request with - Commons Logging please do the following: + Apache Commons Logging please do the following:
- For more information on subversion and creating patches see the - Apache Contributors Guide. + For more information on creating patches see the + Apache Contributors Guide.
You may also find these links useful:
- Commons Logging shares mailing lists with all the other - Commons Components. + Apache Commons Logging shares mailing lists with all the other + Commons Components. To make it easier for people to only read messages related to components they are interested in, the convention in Commons is to prefix the subject line of messages with the component's name, for example: @@ -58,24 +58,29 @@ limitations under the License.
- Questions related to the usage of Commons Logging should be posted to the
- User List.
+ Questions related to the usage of Apache Commons Logging should be posted to the
+ User List.
- The Developer List
- is for questions and discussion related to the development of Commons Logging.
+ The Developer List
+ is for questions and discussion related to the development of Apache Commons Logging.
Please do not cross-post; developers are also subscribed to the user list.
+
+ You must be subscribed to post to the mailing lists. Follow the Subscribe links below
+ to subscribe.
- Note: please don't send patches or attachments to any of the mailing lists. - Patches are best handled via the Issue Tracking system. - Otherwise, please upload the file to a public server and include the URL in the mail. + Note: please don't send patches or attachments to any of the mailing lists; + most of the lists are set up to drop attachments. + Patches are best handled via the Issue Tracking system. + If you have a GitHub account, most components also accept PRs (pull requests). + Otherwise, please upload the file to a public server and include the URL in the mail.
- Please prefix the subject line of any messages for Commons Logging
+ Please prefix the subject line of any messages for Apache Commons Logging
with [logging] - thanks!
@@ -96,16 +101,17 @@ limitations under the License.
Commons User List
- Questions on using Commons Logging.
+ Questions on using Apache Commons Logging.
Subscribe
Unsubscribe
Post
- mail-archives.apache.org
- markmail.org
- www.mail-archive.com
- news.gmane.org
+
+ lists.apache.org
+
+
+ www.mail-archive.com
@@ -114,16 +120,17 @@ limitations under the License.
Commons Developer List
- Discussion of development of Commons Logging.
+ Discussion of development of Apache Commons Logging.
Subscribe
Unsubscribe
Post
- mail-archives.apache.org
- markmail.org
- www.mail-archive.com
- news.gmane.org
+
+ lists.apache.org
+
+
+ www.mail-archive.com
@@ -138,9 +145,11 @@ limitations under the License.
Subscribe
Unsubscribe
read only
- mail-archives.apache.org
- markmail.org
- www.mail-archive.com
+
+ lists.apache.org
+
+
+ www.mail-archive.com
@@ -149,15 +158,17 @@ limitations under the License.
Commons Commits List
- Only for e-mails automatically generated by the source control sytem.
+ Only for e-mails automatically generated by the source control system.
Subscribe
Unsubscribe
read only
- mail-archives.apache.org
- markmail.org
- www.mail-archive.com
+
+ lists.apache.org
+
+
+ www.mail-archive.com
@@ -185,14 +196,14 @@ limitations under the License.
General announcements of Apache project releases.
- Subscribe
- Unsubscribe
+ Subscribe
+ Unsubscribe
read only
- mail-archives.apache.org
- markmail.org
- old.nabble.com
- www.mail-archive.com
- news.gmane.org
+
+ lists.apache.org
+
+
+ www.mail-archive.com