Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 2.22 KB

Contribute

You can contribute to Millistream.NET with issues and pull requests.

Instructions on how to build and test the source code can be found here.

Bug Reports

If you have found a bug, please create an issue where you clearly describe the bug, the expected and actual behaviour, and how to reproduce it.

Include in the description whether the bug is related to the Millistream.Streaming or Millistream.Streaming.DataTypes package, which platform (macOS, Linux or Windows) and version you are running on, which .NET version you are using, and preferably also a minimal, complete and verifiable code example.

Note that you should only file issues that are related to Millistream.NET in this repository. If you have any issues with the wrapped native C/C++ API, you should send an email to tech@millistream.com.

Pull Requests

Before you invest time in coding and submit a pull request, please file an issue and wait for some feedback about the proposed change.

Feature proposals are generally limited to the functionality of the wrapped API and changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the repository will generally not be accepted.

When submitting pull requests, please do:

  • Follow the coding style.
  • Include tests when adding new features or if otherwise applicable.
  • Include a reference to the issue number in the commit message.
  • Target the main branch.
  • Provide a description that clearly describes the problem and solution.

General Questions

If you have a question about the code or anything else related to this repository, feel free to open up an issue and label it as a question.

Code of conduct

See CODE-OF-CONDUCT.md.