@@ -5,10 +5,9 @@ Packaging guidelines
5
5
Thank you very much for packaging vdirsyncer! The following guidelines should
6
6
help you to avoid some common pitfalls.
7
7
8
- While they are called guidelines and therefore theoretically not mandatory, if
9
- you consider going a different direction, please first open an issue or contact
10
- me otherwise instead of just going ahead. These guidelines exist for my own
11
- convenience too.
8
+ If you find yourself needing to patch anything, or going in a different direction,
9
+ please open an issue so we can also address in a way that works for everyone. Otherwise
10
+ we get bug reports for code or scenarios that don't exist in upstream vdirsycner.
12
11
13
12
Obtaining the source code
14
13
=========================
@@ -17,8 +16,7 @@ The main distribution channel is `PyPI
17
16
<https://pypi.python.org/pypi/vdirsyncer> `_, and source tarballs can be
18
17
obtained there. We mirror the same package tarball and wheel as GitHub
19
18
releases. Please do not confuse these with the auto-generated GitHub "Source
20
- Code" tarball; that one contains useless junk and are more of a distraction
21
- than anything else.
19
+ Code" tarball. Those are missing some important metadata and your build will fail.
22
20
23
21
We give each release a tag in the git repo. If you want to get notified of new
24
22
releases, `GitHub's feed
@@ -39,7 +37,7 @@ Testing
39
37
=======
40
38
41
39
Everything testing-related goes through the ``Makefile `` in the root of the
42
- repository or PyPI package. Trying to e.g. run ``py.test `` directly will
40
+ repository or PyPI package. Trying to e.g. run ``pytest `` directly will
43
41
require a lot of environment variables to be set (for configuration) and you
44
42
probably don't want to deal with that.
45
43
0 commit comments