Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

74 lines (48 loc) · 2.61 KB
Raw

Contributing to the official Unmanic-Plugins repo

The following is a set of guidelines for contributing to the project, definitely not rules. Use your best judgment, and feel free to suggest changes.

Table Of Contents

How Can I Contribute?

How Can I Contribute?

Reporting Bugs

When you are creating a bug report, please include as many details as possible. Have a look at the issue template for ideas.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Suggesting New Features

You are welcome to submit ideas for new features and enhancements, just include as many details as possible, including potential implementation options.

Opening Pull Requests

Code contributions are very welcome. However, please understand that by opening a pull requests you hand over copyright ownership of that work to the Unmanic project and the project owner. Your contribution becomes licensed under the same license as the project and ownership is handed over to the project owner. This extends upon paragraph 11 of the Terms & Conditions stipulated in the GPL v3.0.

All new python file contributions must contain the following header:

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""
    Written by:               {{YOUR_NAME}} <{{YOUR_EMAIL}}>
    Date:                     {{DAY_NAME}} {{MONTH}} {{DAY_NUMBER}} {{YEAR}}, ({{TIME}} {{AM_PM}})
 
    Copyright:
        Copyright (C) {{YEAR}} {{YOUR_NAME}}

        This program is free software: you can redistribute it and/or modify it under the terms of the GNU General
        Public License as published by the Free Software Foundation, version 3.

        This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
        implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
        for more details.

        You should have received a copy of the GNU General Public License along with this program.
        If not, see <https://www.gnu.org/licenses/>.

"""

Quality control

The only plugins that will be allowed in the official Plugin repo are those that are vetted and pass a quality control screening process.

All plugins must be tested with the latest release of Unmanic for compatibility.