Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

20 lines (16 loc) · 1.78 KB
Raw

Contributing to Sanctuary Zero

Thanks for taking the time to contribute

The following is a set of guidelines for contributing to Sanctuary Zero, which are maintained by the AstroSonic community on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct for Contributors

This project and everyone participating in it is governed by the code of conduct for contributors which you can find here. By participating, you are expected to uphold this code. Please report unacceptable behavior to socials@astrosonic.tech.

What should I know before getting started?

  1. Sanctuary Zero is an open-source project targeting to facilitate messaging in a secure and synchronous manner.
  2. The transience of messages and anonymity of the users conveying them are the most important things to consider.
  3. In no circumstances can the project replace existing technologies due to its experimental nature of implementation.
  4. The project aims to be secure and ways of achieving it but it is yet to be audited on the basis of security.
  5. The major dependencies that the project makes use of are websockets, python-prompt-toolkit, click and cryptography.
  6. The project is purely written in Python so an experience in the language and the aforesaid dependencies can be helpful.

How can I contribute?

  1. You can report bugs/glitches/faults that you are likely to come across when using the project server and client apps.
  2. You can suggest enhancements that you would want to see implemented on the project - which gets voted in the roadmap.
  3. You can address a wide variety of open issues if you wish to contribute using your code and make a pull request.