Skip to content

Latest commit

 

History

History
154 lines (107 loc) · 8.27 KB

CONTRIBUTING.md

File metadata and controls

154 lines (107 loc) · 8.27 KB
Raw

Regarding contributions

All types of contributions are encouraged and valued. See the Table of contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. We look forward to your contributions.

The project has defined a code of conduct, providing a welcoming and friendly environment. Please adhere to it in all interactions.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of contents

I have a question

Before you ask a question, it is best to search for existing issues and discussions that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Create a discussion.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions, depending on what seems relevant.

We will then take care of the discussion as soon as possible.

I want to contribute

Reporting bugs

Before submitting a bug report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible:

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions.
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace
    • OS and version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How do I submit a good bug report?

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an issue.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. Bugs without steps will not be addressed until they can be reproduced.
  • If the team is able to reproduce the issue, it will be prioritized according to severity.

Suggesting enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

How do I submit a good enhancement suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to.
  • Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your first code contribution

Start by forking the repository, i.e. copying the repository to your account to grant you write access. Continue with cloning the forked repository to your local machine.

git clone https://github.com/<your username>/serilog-sinks-http.git

Navigate into the cloned directory and create a new branch:

cd serilog-sinks-http
git switch -c <branch name>

Update the code according to your requirements, and commit the changes using the conventional commits message style:

git commit -a -m 'Follow the conventional commit messages style to write this message'

Continue with pushing the local commits to GitHub:

git push origin <branch name>

Before opening a Pull Request (PR), please consider the following guidelines:

  • Please make sure that the code builds perfectly fine on your local system.
  • The PR will have to meet the code standard already available in the repository.
  • Explanatory comments related to code functions are required. Please write code comments for a better understanding of the code for other developers.

And finally when you are satisfied with your changes, open a new PR.

Creating a release

Before making an official release, please search for the term Skip = "Beta has been released" and make sure to exercise these tests.

Update the following files:

  • CHANGELOG.md
  • Directory.Build.props

Commit the files with a git commit message saying release v<major>.<minor>.<patch>, and then run the following commands:

git tag -a v<major>.<minor>.<patch> -m v<major>.<minor>.<patch> -s
git push --follow-tags
  • The NuGet package and its symbols will be pushed by CD
  • Update the GitHub release with the information found in CHANGELOG.md