Repository: logging-log4net Updated Branches: refs/heads/develop 40606d321 -> 946cb2111
Contributing: reformatted to markup syntax Project: http://git-wip-us.apache.org/repos/asf/logging-log4net/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4net/commit/946cb211 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4net/tree/946cb211 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4net/diff/946cb211 Branch: refs/heads/develop Commit: 946cb211174ec59137760ee70602da01a851a580 Parents: 40606d3 Author: Dominik Psenner <[email protected]> Authored: Thu Jul 20 13:28:08 2017 +0200 Committer: Dominik Psenner <[email protected]> Committed: Thu Jul 20 13:28:08 2017 +0200 ---------------------------------------------------------------------- CONTRIBUTING.md | 65 +++++++++++++++++++++++----------------------------- 1 file changed, 29 insertions(+), 36 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4net/blob/946cb211/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6d5c24..4848773 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,53 +1,46 @@ -Contributing to Apache log4net -====================== +# Contributing to Apache log4net 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 you're changes on the [dev list](https://logging.apache.org/log4net/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 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. +* 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 you're changes on the [dev list](https://logging.apache.org/log4net/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 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 --------------- +# Making Changes -+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch). -+ Make commits of logical units. -+ Respect the original code style: - + 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. -+ Run all the tests with `nant` inside the `tests` directory to assure nothing else was accidentally broken. +* Create a topic branch from where you want to base your work (this is usually the master/trunk branch). +* Make commits of logical units. +* Respect the original code style: +** 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. +* Run all the tests with `nant` inside the `tests` directory to assure nothing else was accidentally broken. -Making Trivial Changes ----------------------- +# Making 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. -+ 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. +* Sign the [Contributor License Agreement][cla] 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. -Additional Resources --------------------- +# Additional Resources -+ [Apache log4net JIRA project page](https://issues.apache.org/jira/browse/LOG4NET) -+ [Contributor License Agreement][cla] -+ [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) +* [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/) +* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) -[cla]:https://www.apache.org/licenses/#clas
