Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 2.86 KB

Contributing to DVB Inspector

First off, thanks for taking the time to contribute!

All types of contributions and feedback are encouraged and valued. This document only gives you some guidelines and tips on contributing (or contacting me). It is not intended to limit your options. Feel free to use any method or form you are comfortable with.

Table of Contents

Give a Star

The easiest way to show your appreciation is to give the project a star on Github. It encourages me to continue development.

Thank You Email

A bit more personal than giving a star is telling me in an email what you use DVB Inspector for (amateur/professional, type of business,etc.) It does not have to be long.

I Have a Question

If you want to ask a question, did you first read the available user manual?

After reading the user manual feel free to open an Issue.

I Found a Bug

Please check first that you are using the latest version of DVB Inspector. Then open an Issue.

Before Submitting a Bug

  • Please specify which version of DVB inspector you are using.
  • Explain the behaviour you would expect and the actual behaviour .
  • describe the reproduction steps
  • Please provide a sample transport-stream

I Want to Suggest an Enhancement

This section guides you through submitting an enhancement suggestion / feature request for DVB inspector. Following these guidelines will help me to understand your suggestion.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the User Manual carefully and determine if the functionality is already covered, maybe in a (context) menu.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince me of the merits of this feature.
  • Please provide (a link to) relevant documentation and/or a test stream.

I Want to Contribute Code

When you want to fix a bug, or add a new feature/enhancement, and you already created the code for it, the rules above still apply. I still need documentation and/or test data to verify the correctness of your solution.

The preferred method for contribution code is a pull request. When it is only a small change a .patch file may be acceptable. If you want to make a large change it is wise to contact me first, so we can discuss if and where your new feature fits into DVB Inspector.