Repository: logging-log4net Updated Branches: refs/heads/develop e2c73886d -> 35ef4bb34
Readme: updated readme to markup syntax and added a reference to contributing Project: http://git-wip-us.apache.org/repos/asf/logging-log4net/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4net/commit/35ef4bb3 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4net/tree/35ef4bb3 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4net/diff/35ef4bb3 Branch: refs/heads/develop Commit: 35ef4bb3409e84f19a43b5f82263cb49d21de64a Parents: e2c7388 Author: Dominik Psenner <dpsen...@apache.org> Authored: Thu Jul 20 13:49:20 2017 +0200 Committer: Dominik Psenner <dpsen...@apache.org> Committed: Thu Jul 20 13:49:20 2017 +0200 ---------------------------------------------------------------------- CONTRIBUTING.md | 16 +++++++++------- README.md | 17 +++++++++++++++++ README.txt | 30 ------------------------------ 3 files changed, 26 insertions(+), 37 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4net/blob/35ef4bb3/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20f6fc1..984a5e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,17 +2,17 @@ You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. -# Getting Started +# 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 the changes on the [dev list](https://logging.apache.org/log4net/mail-lists.html) first. This way you can make sure you are not wasting your time on something that isn't considered to be in Apache log4net's scope. +* If you're planning to implement a new feature it makes sense to discuss the changes on the [development mailing list](https://logging.apache.org/log4net/mail-lists.html) first. This way you can make sure you are not wasting your time on something that isn't considered to be in Apache log4net's scope. * Submit a ticket 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. -# Making Changes +# Contributing changes * Create a topic branch from where you want to base your work (this is usually the develop branch). * Make commits of logical units. @@ -23,19 +23,21 @@ You have found a bug or you have an idea for a cool new feature? Contributing co * Make sure you have added the necessary tests for your changes. * Run all the tests with `nant` inside the `tests` directory to assure nothing else was accidentally broken. Please note that not all targets can be built on a single machine and therefore only a subset of the actual targets is built and tested. -# Making Trivial Changes +## Trivial changes 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 +## Submitting changes -* Sign the [Contributor License Agreement][cla] if you haven't already. +* For non trivial changes, please sign the [Contributor License Agreement][https://www.apache.org/licences/#clas] 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. +* The build system should automatically attempt to merge, build and test your pull request. Please navigate to [jenkins](https://builds.apache.org/job/logging-log4net) to check the outcome. -# Additional Resources +# Additional resources +* [Log4Net mailing lists](https://logging.apache.org/log4net/mail-lists.html) * [Apache log4net JIRA project page](https://issues.apache.org/jira/browse/LOG4NET) * [Contributor License Agreement][https://www.apache.org/licenses/#clas] * [General GitHub documentation](https://help.github.com/) http://git-wip-us.apache.org/repos/asf/logging-log4net/blob/35ef4bb3/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee9fe93 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Introduction + +Apache log4net is a sub project of the Apache Logging Services project. Apache log4net graduated from the Apache Incubator in February 2007. Please visit the official [website](http://logging.apache.org/log4net) for additional information. + + +# Documentation + +For local documentation, which is correct for this release see: +doc/index.html + +For the latest documentation see the log4net web site at: +http://logging.apache.org/log4net + +# Contributing + +Please read the contributing guidelines before starting to work on a patch, writing issues or file a pull request. The contributing guidelines are available [here](CONTRIBUTING.md). + http://git-wip-us.apache.org/repos/asf/logging-log4net/blob/35ef4bb3/README.txt ---------------------------------------------------------------------- diff --git a/README.txt b/README.txt deleted file mode 100644 index ce2bfb0..0000000 --- a/README.txt +++ /dev/null @@ -1,30 +0,0 @@ -Project Status -============== - -Apache log4net is a sub project of the Apache Logging Services project. -Apache log4net graduated from the Apache Incubator in February 2007. -Web site: http://logging.apache.org/log4net - - -Documentation -============= - -For local documentation, which is correct for this release see: -doc/index.html - -For the latest documentation see the log4net web site at: -http://logging.apache.org/log4net - -Contributing -============ - -log4net development happens on the log4net dev mailing list, see -<https://logging.apache.org/log4net/mail-lists.html>. Please join the -mailing list and discuss bigger changes before working on them. - -For bigger changes we must ask you to sign a Contributor License -Agreement <http://www.apache.org/licenses/#clas>. - -github pull requests are one way to contribute, but our real issue -tracker is JIRA <https://issues.apache.org/jira/browse/LOG4NET>. -
