Siphalor/tweed5-commons-logging
1
0
Fork 0
Code Activity

Prepare for release candidate

Browse Source
This commit is contained in:
Gary Gregory
2023-11-26 16:24:49 -05:00
parent 115812fe62
commit 18ed8eb8ad
9 changed files with 251 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -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
===================
[![Java CI](https://github.com/apache/commons-logging/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-logging/actions/workflows/maven.yml)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/?gav=true)
[![CodeQL](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml/badge.svg)](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.
[![Java CI](https://github.com/apache/commons-logging/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-logging/actions/workflows/maven.yml)
[![Coverage Status](https://codecov.io/gh/apache/commons-logging/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-logging)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/?gav=true)
[![Javadocs](https://javadoc.io/badge/commons-logging/commons-logging/1.3.0.svg)](https://javadoc.io/doc/commons-logging/commons-logging/1.3.0)
[![CodeQL](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-logging/badge)](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
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
<version>1.3.0</version>
</dependency>
```
Building
--------
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
Contributing
------------
We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the code style.
+ Respect the existing code style for each file.
+ 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.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
@@ -84,20 +97,24 @@ You can learn more about contributing via GitHub in our [contribution guidelines
License
-------
This code is under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
You like Apache Commons Logging? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Donating
--------
You like Apache Commons Logging? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/LOGGING)
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
+ `#apache-commons` IRC channel on `irc.freenode.org`
[ml]:https://commons.apache.org/mail-lists.html
Apache Commons Components
-------------------------
Please see the [list of components](https://commons.apache.org/components.html)