proxpn-bash-client
proxpn-bash-client copied to clipboard
MattSurabian
Establish Project Tenants
As we gain more users and (hopefully) contributors it makes sense to establish some core project tenants that can live in the README and help guide feature decisions. There are a few I've been adhering to, which are:
- Keep external dependencies to a minimum
- No unsecured network requests should be required for operation (say, for a list of exit nodes)
- Favor simplicity and code readability to make it easy for folks to understand what the script is actually doing
- Assume the user is new to using the command line, make usage intuitive and errors descriptive
- Maintain cross-distro Linux and OS X support
Do these make sense? Are things missing?
At a glance, sounds reasonable. Also, as a suggestion, you could introduce these guidelines to the project by using this format: GitHub Blog - Contributing Guidelines
:+1: Good call. I usually just put this in the readme, but it would be better to create a distinct file and just link to it in the readme.
Thanks. How can I contribute with a small financial donation? And can you add an update feature in de script with which you start the vpn connection so that the list with exit nodes is always up to date? Or create a PPA?
Hi @hamariko! In reverse order: I'm a bit behind on the effort but there is intention to create a PPA, per #16. I'll update the README and release notes when it finally happens.
I'm not entirely clear on the UX for the exit node list being kept up to date. Currently, to avoid making unsecured network connections to determine what the current server list is, hard coded domain names are used instead. In the event a new exit node is added by ProXPN and not supported by this script please make an issue for that exit node and I'll add it right away and cut a new release. If that's not satisfactory could you describe the behavior you'd be looking for in a new issue so we can open the implementation discussion?
Regarding the financial donation, I'm pleased that you're getting value out of this script, but instead of donating to me I suggest sending the same amount to UNICEF an excellent, trustworthy charity that helps children across the world.