Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

88 lines (68 loc) · 2.87 KB
Raw

Support & contributing guidelines (September 19, 2017)

Do you have feature requests, questions or would you like to report a bug? Please follow these guidelines when posting on the issue list. The issues are labeled with the following guideline.

Feature requests

Please provide the following information:

  • The current NLog version
  • Any current work-arounds
  • Example of the config when implemented. Please use fenced code blocks.
  • Pull requests and unit tests are welcome!

Questions

Please provide the following information:

  • The current NLog version
  • The current config (file content or API calls). Please use fenced code blocks.
  • If relevant: the current result
  • If relevant: the expected result

Bug reports

Please provide the following information:

  • The current NLog version
  • The error message and stacktrace. Please use fenced code blocks.
  • The internal log, Debug level. See Internal Logging
  • The current result
  • The expected result
  • Any current work-arounds
  • The current config (file content or API calls). Please use fenced code blocks.
  • Pull requests and unit tests are welcome!

Pull requests

Unit tests are really appreciated!

Please document any public method and property. Document why and not how. At least required:

  • Method: Summary, param and return.
  • Property: Summary

Multiple .NET versions

Keep in mind that multiple versions of .NET are supported. Some methods are not available in all .NET versions. The following conditional compilation symbols can be used:

#if NET3_5
#if NET4_0
#if NET4_5
#if SILVERLIGHT
#if SILVERLIGHT5
#if MONO
#if MONO_2_0
#if WINDOWS_PHONE
#if WINDOWS_PHONE_7
#if WINDOWS_PHONE_7_1
#if __IOS__
#if __ANDROID__

Update your fork

Is your fork not up-to-date with the NLog code? Most of the time that isn't a problem. But if you like to "sync back" the changes to your repository, execute the following command:

The first time:

git remote add upstream https://github.com/NLog/NLog.git

After that you repository will have two remotes. You could update your remote (the fork) in the following way:

git fetch upstream
git checkout <your feature branch>
git rebase upstream/master
..fix if needed and
git push -f

if rebase won't work well, use git merge master as alternative.

It's also possible to send a PR in the opposite direction, but that's not preferred as it will pollute the commit log.