CONTRIBUTE.md

Contribute.md

Basic info

Our website has a lot of information to get you in touch with us and learn about Psiphon.

• The About page has Psiphon team member info and Google Groups links.

• Our blog has updates about what's going on with Psiphon.

• The Open Source page has a link to our project.

To see who has helped us make Psiphon great, check out the list of contributors.

Reporting bugs, requesting features

You can report bugs and request features by creating an "issue" for our project. If you'd like to discuss Psiphon with the community, visit the psiphon3-users Google Group.

If you encounter an problem while running Psiphon, please also send us feedback from within the app, and include diagnostic information.

Code

We haven't yet received enough code submissions to have come up with detailed instructions for how to write or submit fixes, features, etc. However, we'd be extremely happy for you to help us, so please get in touch with us, or just submit a pull request and we'll figure it out together.

Translations

Psiphon always needs translation help! Psiphon is used all over the world, and primarily in non-English speaking countries. Psiphon is also updated very frequently. Those two facts add up to: we need lots of translations, and we need them updated pretty often.

Psiphon's translation project is hosted on Transifex, which provides an easy web interface for contributing and reviewing translation. If you speak any language other than English, please check it out!

We would also appreciate localized screenshots (right now they're almost exclusively English). Please contact us to send them to us.

Documentation

Most of our documentation can be found on our website. (There's also some in our source code project -- like this document -- but it's mostly technical.)

For example, check out the User Guide, FAQ, and Blog. If you have any suggestions, improvements, expansions, feedback, etc., please let us know (create an issue, or post to our Google Group, or email us).

Community

You can help Psiphon to help its users by participating in the psiphon3-users Google Group. If there's a question or problem that you can help with, feel free to chime in.

Any help that you can give to Psiphon users is a big help to us -- it frees us up to spend more time making Psiphon great.