How To Contribute

  1. Use the Portmaster
    1. Report Bugs, Suggest Features and Improvements
    2. Report Linux Distribution Compatibility
    3. Report VPN Compatibility
    4. Report Software Compatibility
    5. Contribute to the Code
  2. Spread the Word
    1. Tell Your Friends
    2. Tell the Internet
  3. Assist with Documentation and the Website
    1. Report Bugs, Inaccuracies and Typos
    2. Suggest New Sections
    3. Contribute to the Web-Projects
  4. Other, Out-Of-Scope
  5. Appendix: Cheat Sheet
Thanks For Participating!

Your contributions will have the highest impact when aligned with Safing’s current goals and focus. As a result, these are the current scopes where we are super thankful for your participation:

Use the Portmaster

Our projects live on GitHub, so contribution is smoothest with a GitHub account. But you can also send an email to support@safing.io with any reports/ideas/suggestions you have.

Report Bugs, Suggest Features and Improvements

You can easily report bugs as you stumble upon them. It is best if you quickly check other reports to prevent duplicates. If you have any ideas we’d love to hear how you would improve things.

Β  Portmaster User Interface Packaging
🐞 Bug Report report report report
πŸ’‘ Suggestion: New Feature suggest suggest suggest
πŸ’‘ Suggestion: Improvements suggest suggest suggest

Report Linux Distribution Compatibility

Help us understand Portmaster compatibility with different Linux distributions. Whether it works with your distro or not - your reports will help us massively to know where we stand. We will update the Linux compatibility list accordingly.

Report VPN Compatibility

Help us understand Portmaster compatibility with different VPN clients. Whether the VPN client works together with the Portmaster or not - your reports will help us massively to know where we currently stand. All reports are collected, updated and easily accessible in the VPN Compatibility section.

Report Software Compatibility

Have certain applications stopped working with the Portmaster? Or games? Or a special development tool? Your reports will help us massively to know where we currently stand. All reports are collected and easily accessible in the Software Compatibility section.

πŸ“ Compatibility Report: VPN report
πŸ“ Compatibility Report: Linux distro report
πŸ“ Compatibility Report: General Software report

Contribute to the Code

Overall, we do welcome code contributions - but here are two things you must know before starting:

πŸ“‘ A Code License Agreement Is Sometimes Required

Our Code License Agreement gives us full legal flexibility, which we require for our main projects. The openness of the code is in no way hindered by this: Anyone can still fork and do whatever they want with the code according to its license. But if you want to change something in our main repositories we do require to keep ownership of the code. This also applies to small fixes or typos.

πŸ—£ For Anything Bigger Communication with Safing Is A Must

We truly do not want you to spend a lot of your precious time and effort into a feature which would turn out to misalign with our current goals and focus. So please, check with us first via GitHub or support@safing.io before tackling a big pull request.

Β  Portmaster User Interface Packaging
βš”οΈ Pull Request: Typos and Small Fixes πŸ“‘ πŸ“‘ Β 
βš”οΈ Pull Request: Feature Implementation πŸ“‘πŸ—£ πŸ“‘πŸ—£ πŸ—£

Spread the Word

Tell Your Friends

We have no idea how you communicate with your friends; and we do not want to know. But what we do know is that we would not be here without so many of you telling your friends about Safing and Portmaster. Thanks for doing this - it makes all the difference.

Tell the Internet

You can even spread the word wherever you hang out. Share Portmaster in a forum, recommend it being added to a cool list or website. Or just share a blog article you enjoyed on reddit, lobsters, etc. Thanks for sharing!

Assist with Documentation and the Website

Our projects live on GitHub, so contribution is smoothest with a GitHub account. But you can also send an email to support@safing.io with any reports/ideas/suggestions you have.

Report Bugs, Inaccuracies and Typos

We try our best to keep everything running and up-to-date - but you still might find bugs, inaccurate information or typos. In that case, it would be great if you could let us know. Or even create a pull request with a fix.

Suggest New Sections

Our Documentation and Website are living projects. We are happy to hear your ideas on what to add or how to improve:

Β  Documentation Website
🐞 Bug Report report report
🐞 Report: Inaccuracy/Typo report report
πŸ’‘ Suggestion: New Page/Segment suggest suggest
πŸ’‘ Suggestion: Improvements suggest suggest

Contribute to the Web-Projects

We welcome code contributions - still here are two things you must know before starting:

πŸ“‘ A Code License Agreement Is NOT Required for Docs & Website

Opposed to our main repositories we do not require full legal flexibility with these repositories. You can simply clone and set up a pull request with no legal jumbo in your way.

πŸ—£ For Anything Bigger Communication with Safing Is A Must

However, we truly do not want you to spend a lot of your precious time and effort into a feature which would turn out to misalign with our current goals and focus. So please, check with us first via GitHub or support@safing.io before tackling a bigger pull request.

Β  Documentation Website
βš”οΈ Pull Request: Typos and Small Fixes Β  Β 
βš”οΈ Pull Request: Feature Implementation πŸ—£ πŸ—£

Other, Out-Of-Scope

If you want to contribute beyond the listed guide it is best to check with us first. We as a team have limited resources and do not want your precious time and effort to go to waste. So please, check with us first via GitHub or support@safing.io.

Appendix: Cheat Sheet

Our projects live on GitHub, so contribution is smoothest with a GitHub account. But you can also send an email to support@safing.io with any reports/ideas/suggestions you have.

Β  Portmaster User Interface Packaging Docs Website Β  Β 
🐞 Bug Report report report report report report    
πŸ’‘ Suggestion: New Feature suggest suggest suggest suggest suggest Β  Β 
πŸ’‘ Suggestion: Improvements suggest suggest suggest suggest suggest Β  Β 
πŸ“ Compatibility: VPN report Β  Β  Β  Β  Β  Β 
πŸ“ Compatibility: Linux distro report Β  Β  Β  Β  Β  Β 
πŸ“ Compatibility: Software report Β  Β  Β  Β  Β  Β 
βš”οΈ PR: Typos and Small Fixes πŸ“‘ πŸ“‘ Β  Β  Β  Β  Β 
βš”οΈ PR: Feature Implementation πŸ“‘πŸ—£ πŸ“‘πŸ—£ πŸ—£ πŸ—£ πŸ—£ Β  Β