xref: /aosp_15_r20/external/slf4j/README.md (revision d4cc4a21ff30dee54251e974d02850809c70b030)
1*d4cc4a21SXin Li# About SLF4J
2*d4cc4a21SXin Li
3*d4cc4a21SXin LiThe Simple Logging Facade for Java (SLF4J) serves as a simple facade
4*d4cc4a21SXin Lior abstraction for various logging frameworks (e.g. java.util.logging,
5*d4cc4a21SXin Lilogback, reload4j, log4j 2.x) allowing the end user to plug in the desired logging
6*d4cc4a21SXin Liframework at deployment time.
7*d4cc4a21SXin Li
8*d4cc4a21SXin LiMore information can be found on the [SLF4J website](http://www.slf4j.org).
9*d4cc4a21SXin Li
10*d4cc4a21SXin Li# Build Status
11*d4cc4a21SXin Li[![Build Status](https://travis-ci.org/qos-ch/slf4j.svg)](https://travis-ci.org/qos-ch/slf4j)
12*d4cc4a21SXin Li
13*d4cc4a21SXin Li# Search org.slf4j artifacts on Maven Central
14*d4cc4a21SXin Li[![Maven Central](https://img.shields.io/badge/Search%20org%2Eslf4j%20artifacts%20on%20Maven%20Central-2.0.x-green)](https://search.maven.org/search?q=g:org.slf4j%20AND%20v:2.0.%3F)
15*d4cc4a21SXin Li
16*d4cc4a21SXin Li
17*d4cc4a21SXin Li# In case of problems
18*d4cc4a21SXin Li
19*d4cc4a21SXin LiIn case of problems please do not hesitate to post an e-mail message
20*d4cc4a21SXin Lion the [email protected] mailing list.  However, please do not
21*d4cc4a21SXin Lidirectly e-mail SLF4J developers. The answer to your question might
22*d4cc4a21SXin Libe useful to other users. Moreover, there are many knowledgeable users
23*d4cc4a21SXin Lion the slf4j-user mailing lists who can quickly answer your
24*d4cc4a21SXin Liquestions.
25*d4cc4a21SXin Li
26*d4cc4a21SXin Li# Urgent issues
27*d4cc4a21SXin Li
28*d4cc4a21SXin LiFor urgent issues do not hesitate to [champion a release](https://github.com/sponsors/qos-ch/sponsorships?tier_id=77436).
29*d4cc4a21SXin LiIn principle, most championed issues are solved within 3 business days ensued by a release.
30*d4cc4a21SXin Li
31*d4cc4a21SXin Li# How to build SLF4J
32*d4cc4a21SXin Li
33*d4cc4a21SXin LiSLF4J uses Maven as its build tool.
34*d4cc4a21SXin Li
35*d4cc4a21SXin LiSLF4J version 2.0.x will run under Java 8 but requires Java 9 or later to build.
36*d4cc4a21SXin Li
37*d4cc4a21SXin Li# How to contribute pull requests
38*d4cc4a21SXin Li
39*d4cc4a21SXin LiIf you are interested in improving SLF4J, that is great! The SLF4J
40*d4cc4a21SXin Licommunity looks forward to your contribution. Please follow this
41*d4cc4a21SXin Liprocess:
42*d4cc4a21SXin Li
43*d4cc4a21SXin Li1. Start a discussion on the [slf4j-dev mailing
44*d4cc4a21SXin Lilist](http://www.slf4j.org/mailing-lists.html) about your proposed
45*d4cc4a21SXin Lichange. Alternately, file a [bug
46*d4cc4a21SXin Lireport](http://www.slf4j.org/bug-reporting.html) to initiate the
47*d4cc4a21SXin Lidiscussion. Note that we ask pull requests to be linked to a [Jira
48*d4cc4a21SXin Liticket](https://jira.qos.ch/).
49*d4cc4a21SXin Li
50*d4cc4a21SXin Li2. Fork qos-ch/slf4j. Ideally, create a new branch from your fork for
51*d4cc4a21SXin Liyour contribution to make it easier to merge your changes back.
52*d4cc4a21SXin Li
53*d4cc4a21SXin Li3. Make your changes on the branch you hopefully created in Step 2. Be
54*d4cc4a21SXin Lisure that your code passes existing unit tests. Please add unit tests
55*d4cc4a21SXin Lifor your work if appropriate. It usually is.
56*d4cc4a21SXin Li
57*d4cc4a21SXin Li4. All commits must have signed off by the contributor attesting to
58*d4cc4a21SXin Li[Developer Certificate of Origin
59*d4cc4a21SXin Li(DCO)](https://developercertificate.org/). Commits without sign off
60*d4cc4a21SXin Liwill be automatically rejected by the [DCO GitHub
61*d4cc4a21SXin Licheck](https://probot.github.io/apps/dco/) application.
62*d4cc4a21SXin Li
63*d4cc4a21SXin Li5. Push your changes to your fork/branch in GitHub. Don't push it to
64*d4cc4a21SXin Liyour master! If you do it will make it harder to submit new changes
65*d4cc4a21SXin Lilater.
66*d4cc4a21SXin Li
67*d4cc4a21SXin Li6. Submit a pull request to SLF4J from your commit page on GitHub.
68*d4cc4a21SXin Li
69*d4cc4a21SXin Li7. Did we mention that you will be asked to link your pull request
70*d4cc4a21SXin Liwith a Jira ticket?
71