Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 2.71 KB
Raw

Contributing to the Serilog Console Sink

First of all thanks for dropping by, feel free to checkout Serilog core project's contributing page which contains some key points about the organisation.

Reporting an issue

Bugs are tracked via GitHub issues. Below are some notes to help create a new issue. The issue template will help you on the way.

  • Create an issue via the issues list.
  • List the version of Serilog that is affected
  • List the target framework and operating system
  • If possible, provide a sample that reproduces the issue.

Requesting a feature/enhancement

Feature as also tracked via GitHub issues. Below are some notes to help create an issue. The issue template will help you on the way

  • Create an issue via the issues list.
  • List the version of Serilog that is affected
  • List the target framework and operating system
  • If possible, provide a sample that reproduces the issue.

Making a PR

  • If an issue does not already exist please create one via the issues list.
  • Fork the repository and create a branch with a descriptive name.
  • Attempt to make commits of logical units.
  • When committing, please reference the issue the commit relates to.
  • Run the build and tests.
    • Windows platforms can use the build.ps1 script. (This is the script used in AppVeyor builds)
    • nix/OSX platforms can use the build.sh script. (This is the script used in Travis builds)
  • Create the PR, the PR template will help provide a stub of what information is required including:
    • The issue this PR addresses
    • Unit Tests for the changes have been added.

Questions?

Serilog has an active and helpful community who are happy to help point you in the right direction or work through any issues you might encounter. You can get in touch via:

Finally when contributing please keep in mind our Code of Conduct.