chore: update documentation

CONTRIBUTING.md

@@ -1,15 +1,43 @@
-# Contributors
+# Contributing to python-lint-plus
 
-## Checkin
+Thank you for taking the time to contribute!
 
-- Do checkin source
-- Do not checkin devDependency pipenv
-- Do not checkin IDE files
+## Code of Conduct
 
-## devDependencies
+The fundamental rules are:
 
-The project dependencys are in [docker image](https://github.com/ricardochaves/python-lint-image).
+* **DON'T be a Gavin Belson.**  You probably are smarter and more successful than everone else, but be humble and helpful.
+* **DON'T be a Jian Yang.**  Stealing other people's IP is lower than a snake's belly.
+* You *CAN* be a Bertram Gilfoyle, that's fundamentally just being an engineer.
+* You *CAN* be a Big Head, but only if you invite me to all your house parties.
+* You *CAN* be an Erlich Bachman because the world needs dreamers.
+* You *CAN* be a Richard Hendricks, because ethical software is a good thing.
+* You *CAN* be a Dinesh Chugtai because every team needs someone to good-heartedly pick on.
 
-## entrypoint
+# How Can I Contribute?
+
+## For Everyone
+
+### Reporting Issues
+
+> The only dumb issue is the unreported issue.
+
+The purpose of an issue (or bug, condition, corrective action, FRACA) tracking system is to document **conditions adverse to quality (CAQ)** and their fixes.  A mispelled word in documentation or a docstring is a condition adverse to quality so *submit an issue*.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+#### Before Submitting an Issue Report
+
+**Perform a search** to see if the problem has already been reported.  If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
+
+### Pull Requests
+
+When opening a pull request:
+
+* Do not include issue numbers in the PR title.
+* Include screenshots in your pull request whenever possible.
+* Document new engineering specification(s).
+* Document new code.
+* End all files with a newline.
+* Avoid platform-dependent code.
 
-Keep [entrypoint.sh](../entrypoint.sh) readable. The idea is that everyone can read, even those who don't know much about shell script.

README.md

@@ -40,7 +40,7 @@ Each run of the action creates a virtual environment.  Each of the enabled
 tools is installed in this virtual environment before that tool is executed.
 The default name of the virtual environment is ```python-lint-plus```, but you 
 can set it to whatever you'd like with the ```virtual-env``` option.
-This can be helpful if your running a matrix of various versions of python.
+This can be helpful if you're running a matrix of various versions of python.
 
 ## Usage