Merge pull request #117 from GouveaHeitor/develop

Develop

.github/CONTRIBUTING.md

@@ -1,9 +1,28 @@
 # Contributing to the Nipe!
 
-## License
+## Branches
 
-By opening a pull request in this repository, you agree to provide your work under the [project license](../LICENSE.md).
+The `master` branch is used only for holding released code of the project. Any
+new feature or bugfix **must** be opened against `develop` branch, where some
+additional testing is performed before the code lands `master`.
+
+## Testing
+
+For every new feature, please, submit in the same PR a testing code (under
+`t/` folder) to cover that completely. Make sure to expand and cover the
+added/replaced code as much as possible.
+
+In case it's a functional bugfix (not a typo, commentary, whitespace, ...
+issue), make sure to check why the test code didn't trigger the bug before
+and, if possible, update the test.
 
 ## Great Re-Writings
 
-Open a discussion issue before you begin. So we can listen to what you have to say, and we can provide a referral if it will be worth changing big parts of the project.
+Open a discussion issue before you begin. So we can listen to what you have to
+say, and we can provide a referral if it will be worth changing big parts of
+the project.
+
+## License
+
+By opening a pull request in this repository, you agree to provide your work
+under the [project license](../LICENSE.md).

README.md

@@ -1,7 +1,6 @@
 <p align="center">
   <img src="https://heitorgouvea.me/images/projects/nipe/logo.png">
   <p align="center">An engine to make Tor Network your default gateway.</p>
-
   <p align="center">
     <a href="/LICENSE.md">
       <img src="https://img.shields.io/badge/license-MIT-blue.svg">
@@ -12,8 +11,6 @@
   </p>
 </p>
 
-
-
 ---
 
 ### Summary
@@ -44,7 +41,7 @@ All non-local UDP/ICMP traffic is also blocked by the Tor project.
 ---
 
 ### Commands:
-```bash
+```
   COMMAND          FUNCTION
   install          Install dependencies
   start            Start routing
@@ -60,12 +57,15 @@ All non-local UDP/ICMP traffic is also blocked by the Tor project.
   perl nipe.pl restart
   perl nipe.pl status
 ```
+
 ---
 
 ### Demo
 
 ![Image](https://heitorgouvea.me/images/projects/nipe/demo.gif)
 
+---
+
 ### Contribution
 
 - Your contributions and suggestions are heartily ♥ welcome. [See here the contribution guidelines.](/.github/CONTRIBUTING.md) Please, report bugs via [issues page](https://github.com/GouveaHeitor/nipe/issues) and for security issues see here the [security policy.](/SECURITY.md) (✿ ◕‿◕) This project follows the best practices defined by this [style guide](https://heitorgouvea.me/projects/perl-style-guide).
@@ -92,4 +92,4 @@ All non-local UDP/ICMP traffic is also blocked by the Tor project.
 
 ### License
 
-- This work is licensed under [MIT License.](/LICENSE.md)
+- This work is licensed under [MIT License.](/LICENSE.md)

nipe.pl

@@ -12,8 +12,9 @@ use Nipe::Utils::Status;
 use Nipe::Utils::Helper;
 use Nipe::Utils::Install;
 
+
 sub main {
-	die "$0 must be run as root" if $> != 0;
+	die "Nipe must be run as root.\n" if $> != 0;
 
 	my $argument = $ARGV[0];