| 1 |
# Contributing to netplan.io |
| 2 |
|
| 3 |
Thanks for taking the time to contribute to netplan! |
| 4 |
|
| 5 |
Here are the guidelines for contributing to the development of netplan. These |
| 6 |
are guidelines, not hard and fast rules; but please exercise judgement. Feel |
| 7 |
free to propose changes to this document. |
| 8 |
|
| 9 |
#### Table Of Contents |
| 10 |
|
| 11 |
[Code of Conduct](#code-of-conduct) |
| 12 |
|
| 13 |
[What should I know before I get started](#what-should-i-know-before-i-get-started) |
| 14 |
* [Did you find a bug?](#did-you-find-a-bug) |
| 15 |
* [Code Quality](#code-quality) |
| 16 |
* [Conventions](#conventions) |
| 17 |
|
| 18 |
## Code of Conduct |
| 19 |
|
| 20 |
This project and everyone participating in it is governed by the |
| 21 |
[Ubuntu Code of Conduct](https://www.ubuntu.com/community/code-of-conduct). |
| 22 |
By participating, you are expected to uphold this code. Please report |
| 23 |
unacceptable behavior to |
| 24 |
[[email protected]](mailto:[email protected]). |
| 25 |
|
| 26 |
## What should I know before I get started? |
| 27 |
|
| 28 |
### Did you find a bug? |
| 29 |
|
| 30 |
If you've found a bug, please make sure to report it on Launchpad against the |
| 31 |
[netplan](http://bugs.launchpad.net/netplan) project. We do use these bug reports |
| 32 |
to make it easier to backport features to supported releases of Ubuntu: having |
| 33 |
an existing bug report, with people who understand well how the bug appears |
| 34 |
helps immensely in making sure the feature or bug fix is well tested when it is |
| 35 |
being released to supported Ubuntu releases. |
| 36 |
|
| 37 |
### Code quality |
| 38 |
|
| 39 |
We want to maintain the quality of the code in netplan to the highest possible |
| 40 |
degree. As such, we do insist on keeping a code coverage with unit tests to 100% |
| 41 |
coverage if it is possible. If not, please make sure to explain why when submitting |
| 42 |
a pull request, and expect reviewers to challenge you on that decision and suggest |
| 43 |
a course of action. |
| 44 |
|
| 45 |
### Conventions |
| 46 |
|
| 47 |
The netplan project mixes C and python code. Generator code is generally all |
| 48 |
written in C, while the UI / command-line interface is written in python. Please |
| 49 |
look at the surrounding code, and make a best effort to follow the general style |
| 50 |
used in the code. We do insist on proper indentation (4 spaces), but we will |
| 51 |
not block good features and bug fixes on purely style issues. Please exercise |
| 52 |
your best judgement: if it looks odd or too clever to you, chances are it will |
| 53 |
look odd or too clever to code reviewers. In that case, you may be asked for |
| 54 |
some styles changes in a pull request. Similarly, if you see code that you |
| 55 |
find hard to understand, we do encourage that you submit pull requests that |
| 56 |
help make the code easier to understand and maintain. |