File: CONTRIBUTING.md

package info (click to toggle)
python-mapnik 1%3A0.0~20200224-7da019cf9-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 11,036 kB
  • sloc: python: 12,085; cpp: 5,718; sh: 101; makefile: 16
file content (34 lines) | stat: -rw-r--r-- 1,016 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Contributing

General guidelines for contributing to python-mapnik

## Coding Conventions

See the [Mapnik guide](https://github.com/mapnik/mapnik/blob/master/docs/contributing.md#coding-conventions).

### Python Style Guide

All python code should follow PEP8 as closely as possible. However, we do not strictly enforce all PEP8 such as 80 characters per line.

## Testing

In order for any code to be pulled into master it must contain tests for **100%** of all lines. The only lines that are not required to be tested are those that cover extreme cases which can not be tested with regularity, such as race conditions. 

If this case does occur you can put a comment block such as shown below to exclude the lines from test coverage.

```C++
// LCOV_EXCL_START
can_not_reach_code();
// LCOV_EXCL_END
```

## Releasing

To release a new python-mapnik version:

Currently just hit up @flippmoke, this section will be filled out ASAP!

### Documentation

TODO: Write documentation on how to update documentation.