When contributing to this repository, first read and agree with the contents of this document fully before beginning to produce any material work for Syphon.
We have a code of conduct, please follow it in all your interactions with the project.
Syphon has a Code of Conduct to which all contributors must adhere. Please first read through the Standards section before continuing through this document.
Join the Syphon General chat on Matrix and let us know you'd like to start contributing to the project!
We'll invite you to the dev room and chat about how you'd like to get started! This way we can coordinate tasks together so no one duplicates work.
If you'd prefer to reach out through email, you can always reach us at [email protected]
Alternatively, you can message the creator of Syphon at (https://matrix.to/#/@ereio:matrix.org) and they will help you get started.
If you're writing code, make sure to fully read the Building section of the readme and confirm you can build Syphon on your platform of choice. If you're having trouble, it's worth taking a look at our CI pipeline scripts for instructions on building per platform.
If you've taken on a task with a corresponding Github issue in the repo, make sure to open a Draft Pull Request in github so we can track your work on the project from start to finish. We'll also assign issues and tags to the Draft PR so other devs and interested users will know that feature is being developed
When your PR is ready, switch the PR from a Draft to Ready for Review. Maintainers will be notified and will review the project, leaving comments for necesssary changes or approval. Once approved, you can merge the PR at your lesiure or if the option is not available, we'll merge your PR shortly after approval.