Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.42 KB

Contributing to vObject

Welcome, and thanks for considering contributing to vObject!

This document is an incomplete draft

Contributions can take many forms, from coding major features, through triaging issues, writing documentation, assisting users, etc, etc. You can, of course, just dive right in, but it's generally a good idea to open an issue (if the contribution addresses a problem) or a discussion to discuss your plans first. This avoids duplicate effort, and builds the community of contributors.

In all interactions, contributors should be polite, kind, and respectful of others. Remember that not everyone lives in the same country, speaks English as their native language, or has the same level of experience and confidence.

Python Code

vObject is licensed under the Apache 2.0 License, and any code or documentation can only be accepted under those terms. You do not need a formal statement of origin, and are not required to sign over your copyright.

All new code should adhere to the PEP-8 conventions, with some exceptions possible when extending older APIs for consistency with what's already there.

The supported Python versions are discussed in #1, and care needs to be taken to not use features that are unavailable in the older supported releases.

With the possible exception of major releases, all contributions must maintain the existing API's syntax and semantics.