@@ -5,10 +5,9 @@ Packaging guidelines
55Thank you very much for packaging vdirsyncer! The following guidelines should
66help you to avoid some common pitfalls.
77
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.
1211
1312Obtaining the source code
1413=========================
@@ -17,8 +16,7 @@ The main distribution channel is `PyPI
1716<https://pypi.python.org/pypi/vdirsyncer> `_, and source tarballs can be
1817obtained there. We mirror the same package tarball and wheel as GitHub
1918releases. 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.
2220
2321We give each release a tag in the git repo. If you want to get notified of new
2422releases, `GitHub's feed
@@ -39,7 +37,7 @@ Testing
3937=======
4038
4139Everything 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
4341require a lot of environment variables to be set (for configuration) and you
4442probably don't want to deal with that.
4543
0 commit comments