Repository: logging-log4net Updated Branches: refs/heads/develop 946cb2111 -> e2c73886d
Contributing: fixed whitespaces and typos Project: http://git-wip-us.apache.org/repos/asf/logging-log4net/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4net/commit/e2c73886 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4net/tree/e2c73886 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4net/diff/e2c73886 Branch: refs/heads/develop Commit: e2c73886d59d1516b6faa3176223c03648a9c1f5 Parents: 946cb21 Author: Dominik Psenner <[email protected]> Authored: Thu Jul 20 13:38:59 2017 +0200 Committer: Dominik Psenner <[email protected]> Committed: Thu Jul 20 13:38:59 2017 +0200 ---------------------------------------------------------------------- CONTRIBUTING.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4net/blob/e2c73886/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4848773..20f6fc1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,12 @@ # 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. +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 * 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. +* 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. * 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. @@ -16,19 +14,18 @@ follow so that we can have a chance of keeping on top of things. # Making Changes -* Create a topic branch from where you want to base your work (this is usually the master/trunk branch). +* Create a topic branch from where you want to base your work (this is usually the develop 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. +* 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 -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. +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
