Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.29 KB

How to contribute to Yopass

First of all for thanks for taking the time to contribute to Yopass!

I found a bug

Please submit an issue with a detailed description describing what happened and with as much relevant information as possible. Such information might be:

  • Browser info
  • Docker version
  • Go version (for server/cli)
  • Webserver configuration (running reverse proxy or built-in webserver)

Pull Requests and features

  • Make sure that bigger changes and features have been discussed before sending the pull request.
  • Smaller tweaks does not need prior discussion.
  • All changes should have tests.

I want to help out

Fantastic! Issues tagged with help wanted are ready to be picked up. If you have other ideas on how to improve please reach out in an issue :)

I need installation help

Yopass is deployed as a docker container which means very little configuration is needed if you know docker. If that's not the case I suggest you start by learning how to run a docker container and how to expose ports. There's also a docker-compose.yaml file available in the deploy folder which make the basic setup very easy. I do offer any help installing the service more then the already supplied installation instructions. Improvements to the installation instructions are always welcome.