Another way to check if pass the test

.travis.yml

@@ -28,4 +28,4 @@ deploy:
   password: $PYPI_PASSWORD
   on:
     branch: master
-    condition: $SHOULD_DEPLOY = 1
+condition: $SHOULD_DEPLOY = 1

CONTRIBUTING.md

@@ -37,24 +37,36 @@ You can contribute in many ways:
   ```shell
   $ py.test
   ```
+6. If execute py.test and always collect 0 items, then you can try to run
 
-6. Commit your changes and push your branch to GitHub::
+  ```shell
+  $ sudo pip install PyBeacon
+  ```
+  if your install success and execute just like you expect, then you can suggest that you have already pass the test.
+
+7. Commit your changes and push your branch to GitHub::
 
   ```shell
   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   ```
 
-7. Submit a pull request through the [GitHub website](https://github.com/nirmankarta/PyBeacon).
+7. Submit a pull request through the [GitHub website](https://github.com/forksociety/PyBeacon).
+
+## How to contribute?
+* Follow the Getting Started guidelines to get a headstart.
+* Create an issue first and then get it approved before creating a PR to allow for better management.
+* Make sure to make PRs against the `dev` branch.
+* No trivial edits, ie. simply rearranging topics will not be accepted.
 
 ## Types of Contributions
 
 You can contribute in many ways:
 
 ### Report Bugs
 
-Report bugs at https://github.com/nirmankarta/PyBeacon/issues.
+Report bugs at https://github.com/forksociety/PyBeacon/issues.
 
 If you are reporting a bug, please include:
 

PyBeacon/PyBeacon.py

@@ -84,6 +84,7 @@ def encodeurl(url):
             data.append(s)
             i += len(scheme)
             break
+        """if never match to if, then throw exception."""
     else:
         raise Exception("Invalid url scheme")
 
@@ -111,6 +112,7 @@ def encodeUid(uid):
     ret = []
     for i in range(0, len(uid), 2):
         ret.append(int(uid[i:i+2], 16))
+    """Python's final character"""
     ret.append(0x00)
     ret.append(0x00)
     return ret
@@ -119,6 +121,7 @@ def uidIsValid(uid):
     """UID Validation."""
     if len(uid) == 32:
         try:
+            """Must not be alpha except ABCDEF"""
             int(uid, 16)
             return True
         except ValueError:
@@ -170,6 +173,7 @@ def decodeUrl(encodedUrl):
     """
     decodedUrl = schemes[encodedUrl[0]]
     for c in encodedUrl[1:]:
+        """Unprintable character"""
         if c <= 0x20:
             decodedUrl += extensions[c]
         else: