@@ -17,8 +17,8 @@ apologies. I know I can mess up. I can't expect you to tell me, but if you
17
17
choose to do so, I'll do my best to handle criticism constructively.
18
18
-- Aymeric) *
19
19
20
- Contributions
21
- -------------
20
+ Contributing
21
+ ------------
22
22
23
23
Bug reports, patches and suggestions are welcome!
24
24
@@ -34,6 +34,28 @@ websockets.
34
34
.. _issue : https://github.com/python-websockets/websockets/issues/new
35
35
.. _pull request : https://github.com/python-websockets/websockets/compare/
36
36
37
+ Packaging
38
+ ---------
39
+
40
+ Some distributions package websockets so that it can be installed with the
41
+ system package manager rather than with pip, possibly in a virtualenv.
42
+
43
+ If you're packaging websockets for a distribution, you must use `releases
44
+ published on PyPI `_ as input. You may check `SLSA attestations on GitHub `_.
45
+
46
+ .. _releases published on PyPI : https://pypi.org/project/websockets/#files
47
+ .. _SLSA attestations on GitHub : https://github.com/python-websockets/websockets/attestations
48
+
49
+ You mustn't rely on the git repository as input. Specifically, you mustn't
50
+ attempt to run the main test suite. It isn't treated as a deliverable of the
51
+ project. It doesn't do what you think it does. It's designed for the needs of
52
+ developers, not packagers.
53
+
54
+ On a typical build farm for a distribution, tests that exercise timeouts will
55
+ fail randomly. Indeed, the test suite is optimized for running very fast, with a
56
+ tolerable level of flakiness, on a high-end laptop without noisy neighbors. This
57
+ isn't your context.
58
+
37
59
Questions
38
60
---------
39
61
0 commit comments