sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-04-27 14:57:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Rework packaging guidelines a bit

Browse source
This commit is contained in:
Hugo Osvaldo Barrera 2020-08-06 12:39:31 +02:00
parent 68ff37e677
commit 2650a7ed0b
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/packaging.rst
View file

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