From 9ce38e487bc6db1321fa6db74019a1c92d09c293 Mon Sep 17 00:00:00 2001 From: Ceki Gulcu Date: Fri, 9 Aug 2019 23:30:23 +0200 Subject: [PATCH] update to README.md --- README.md | 38 +++++++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 34f94a77f..a4300798c 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,39 @@ More information can be found on the [SLF4J website](http://www.slf4j.org). # Build Status [![Build Status](https://travis-ci.org/qos-ch/slf4j.svg)](https://travis-ci.org/qos-ch/slf4j) + +# How to build SLF4J + +SLF4J requires Maven. + +All versions uptp and including 1.7 require Java 5 or later to +build. SLF4J version 2.0.x requires Java 9 or later. + # How to contribute pull requests -If you are interested in improving SLF4J, great! The SLF4J community looks forward to your contribution. Please follow this process: -1. Start a discussion on the [slf4j-dev mailing list](http://www.slf4j.org/mailing-lists.html) about your proposed change. Alternately file a [bug report](http://www.slf4j.org/bug-reporting.html). -2. Fork qos-ch/slf4j. Ideally, create a new branch from your fork for your contribution to make it easier to merge your changes back. -3. Make your changes on the branch you hopefuly created in Step 2. Be sure that your code passes existing unit tests. Please add unit tests for your work if appropriate. It usually is. -4. Push your changes to your fork/branch in github. Don't push it to your master! If you do it will make it harder to submit new changes later. +If you are interested in improving SLF4J, that is great! The SLF4J +community looks forward to your contribution. Please follow this +process: + +1. Start a discussion on the [slf4j-dev mailing +list](http://www.slf4j.org/mailing-lists.html) about your proposed +change. Alternately, file a [bug +report](http://www.slf4j.org/bug-reporting.html) to initiatite the +discussion. Note that we usually ask most pull requests to be linked +to a Jira ticket. + +2. Fork qos-ch/slf4j. Ideally, create a new branch from your fork for +your contribution to make it easier to merge your changes back. + +3. Make your changes on the branch you hopefuly created in Step 2. Be +sure that your code passes existing unit tests. Please add unit tests +for your work if appropriate. It usually is. + +4. Push your changes to your fork/branch in github. Don't push it to +your master! If you do it will make it harder to submit new changes +later. + 5. Submit a pull request to SLF4J from from your commit page on github. + +6. Did we mention that you will be asked to link your pull request +with a Jira ticket? \ No newline at end of file