kapsikkum-unmanic – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 # Contributing to Unmanic
2  
3 The following is a set of guidelines for contributing to the project,
4 definitely not rules. Use your best judgment, and feel free to suggest changes.
5  
6 #### Table Of Contents
7  
8 [How Can I Contribute?](#how-can-i-contribute)
9 * [Reporting Bugs](#reporting-bugs)
10 * [Suggesting New Features](#suggesting-new-features)
11 * [Opening Pull Requests](#opening-pull-requests)
12  
13 ## How Can I Contribute?
14  
15 ### Reporting Bugs
16  
17 When you are creating a bug report, please include as many details as
18 possible. Have a look at the [issue template](ISSUE_TEMPLATE.md) for ideas.
19  
20 > **Note:** If you find a **Closed** issue that seems like it is the same thing
21 > that you're experiencing, open a new issue and include a link to the original
22 > issue in the body of your new one.
23  
24  
25 ### Suggesting New Features
26  
27 You are welcome to submit ideas for new features and enhancements, just include
28 as many details as possible, including potential implementation options.
29  
30  
31 ### Developing
32  
33 See [Development Environment Guide](./DEVELOPING.md) for details on setting up a local
34 development environment.
35  
36  
37 ### Opening Pull Requests
38  
39 Code contributions are very welcome. However, please understand that by opening a pull
40 requests you hand over copyright ownership of that work to the Unmanic project and the
41 project owner.
42 Your contribution becomes licensed under the same license as the project and ownership
43 is handed over to the project owner.
44 This extends upon paragraph 11 of the Terms & Conditions stipulated in the GPL v3.0
45  
46 All pull requests must be opened to merge into the staging branch. No pull requests
47 will be merged into the master branch.
48  
49 All new python file contributions must contain the following header:
50  
51 ```
52 #!/usr/bin/env python3
53 # -*- coding: utf-8 -*-
54  
55 """
56 unmanic.{{FILE_NAME}}
57  
58 Written by: {{YOUR_NAME}} <{{YOUR_EMAIL}}>
59 Date: {{DAY_NAME}} {{MONTH}} {{DAY_NUMBER}} {{YEAR}}, ({{TIME}} {{AM_PM}})
60  
61 Copyright:
62 Copyright (C) Josh Sunnex - All Rights Reserved
63  
64 Permission is hereby granted, free of charge, to any person obtaining a copy
65 of this software and associated documentation files (the "Software"), to deal
66 in the Software without restriction, including without limitation the rights
67 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
68 copies of the Software, and to permit persons to whom the Software is
69 furnished to do so, subject to the following conditions:
70  
71 The above copyright notice and this permission notice shall be included in all
72 copies or substantial portions of the Software.
73  
74 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
75 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
76 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
77 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
78 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
79 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
80 OR OTHER DEALINGS IN THE SOFTWARE.
81  
82 """
83 ```
84  
85 By adding this header you agree to relinquish copyright control to the Unmanic project
86 and its owner.
87  
88 Only submissions that conform to this will be merged into the mainline project. This ensures
89 that Unmanic as a project is free to grow following any path that opens up at the discretion
90 of the project's owner.
91