How To Contribute
- Use the Portmaster
- Other, Out-Of-Scope
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:
Our projects live on GitHub, so contribution is smoothest with a GitHub account. But you can also send an email to email@example.com with any reports/ideas/suggestions you have.
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.
|🐞 Bug Report||report||report||report|
|💡 Suggestion: New Feature||suggest||suggest||suggest|
|💡 Suggestion: Improvements||suggest||suggest||suggest|
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.
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. We will extend the VPN Compatibility section with a table of compatibility and update that based on your reports.
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. We will create a Software Compatibility section with a table of compatible software and update that based on your reports.
|📝 Compatibility Report: VPN||report|
|📝 Compatibility Report: Linux distro||report|
|📝 Compatibility Report: General Software||report|
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 firstname.lastname@example.org before tackling a big pull request.
|⚔️ Pull Request: Typos and Small Fixes||📑||📑|
|⚔️ Pull Request: Feature Implementation||📑🗣||📑🗣||🗣|
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 email@example.com.