Contributing
============

Thanks for taking the time to contribute to websockets!

Code of Conduct
---------------

This project and everyone participating in it is governed by the `Code of
Conduct`_. By participating, you are expected to uphold this code. Please
report inappropriate behavior to aymeric DOT augustin AT fractalideas DOT com.

.. _Code of Conduct: https://github.com/aaugustin/websockets/blob/main/CODE_OF_CONDUCT.md

*(If I'm the person with the inappropriate behavior, please accept my
apologies. I know I can mess up. I can't expect you to tell me, but if you
choose to do so, I'll do my best to handle criticism constructively.
-- Aymeric)*

Contributions
-------------

Bug reports, patches and suggestions are welcome!

Please open an issue_ or send a `pull request`_.

Feedback about the documentation is especially valuable, as the primary author
feels more confident about writing code than writing docs :-)

If you're wondering why things are done in a certain way, the :doc:`design
document <../topics/design>` provides lots of details about the internals of
websockets.

.. _issue: https://github.com/aaugustin/websockets/issues/new
.. _pull request: https://github.com/aaugustin/websockets/compare/

Questions
---------

GitHub issues aren't a good medium for handling questions. There are better
places to ask questions, for example Stack Overflow.

If you want to ask a question anyway, please make sure that:

- it's a question about websockets and not about :mod:`asyncio`;
- it isn't answered in the documentation;
- it wasn't asked already.

A good question can be written as a suggestion to improve the documentation.

Cryptocurrency users
--------------------

websockets appears to be quite popular for interfacing with Bitcoin or other
cryptocurrency trackers. I'm strongly opposed to Bitcoin's carbon footprint.

I'm aware of efforts to build proof-of-stake models. I'll care once the total
energy consumption of all cryptocurrencies drops to a non-bullshit level.

You already negated all of humanity's efforts to develop renewable energy.
Please stop heating the planet where my children will have to live.

Since websockets is released under an open-source license, you can use it for
any purpose you like. However, I won't spend any of my time to help you.

I will summarily close issues related to Bitcoin or cryptocurrency in any way.
