When reviewing a pull request, check the following:
- Ensure the pull request has a good, descriptive name.
- Important: Check for binary backwardscompatiblity. NB: new optional parameters are not binary compatible.
- Important: set the Milestone.
- Add the applicable Labels.
Eg.- Part:
file-target
,nlog-configuration
etc - Type:
bug
,enhancement
,feature
,performance
. Andenhancement
is a change without functional impact. Small features are also labeled asfeature
. - Tests:
needs unittests
,has unittests
- Status:
waiting for review
,almost ready
,ready for merge
- Part:
- Set the Assignee. It must indicate who is currently holding the ball.
For example, if you intend to review, assign to yourself. If, after the review, some changes need to be made, assign it back to the PR author.
Things to check before applying the PR.
- Check if the comment of the PR has an
fixes ...
comment. - Check which documentation has to be done. Preferred to fix the documentation just before the merge of the PR>
- Check for related issues and PR's
- Double check binary backwardscompatiblity.
- Add current milestone.
For developing: the following platforms will be used:
- net46;net45;net35;netstandard1.3;netstandard1.5;netstandard2.0 (see nlog.csproj)
The build server will run unit-tests on both Windows and Linux platforms (see build.ps1 + run-tests.ps1)
See build.ps1
- "BuildLastMajorVersion" should be
major.0.0
. In NLog 4.x - 4.y: 4.0.0 - "AssemblyFileVersion" should be:
major.minor.patch.appVeyorBuildVersion
, eg. 4.2.2.1251 for NLog 4.2.2 - "BuildVersion" should be:
major.minor.patch
where.patch
is ommited when 0. E.g 4.0, 4.1, 4.1.1, 4.2
Example of correct version numbers in NuGet Package explorer:
The XSD file of NLog.Schema is partly generated by "MakeNLogXSD" (inside tools). The enhances the following template: https://github.com/NLog/NLog/blob/master/tools/MakeNLogXSD/TemplateXSD.xml