Merge pull request #2 from badpacketsllc/1-correct-documentation

Correct and update documentation

Author: tmursch

CODE_OF_CONDUCT.md

@@ -2,76 +2,126 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
 
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[homepage]: https://www.contributor-covenant.org
 
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -11,7 +11,7 @@ You can contribute in several different ways:
 
 ### Report bugs
 
-Report bugs at https://github.com/badpacketsllc/prospector/issues.
+Report bugs at https://github.com/badpacketsllc/docker-prospector/issues.
 
 If you are reporting a bug, please include:
 
@@ -37,35 +37,38 @@ suite or wherever you feel is appropriate.
 Setting up a development environment
 ------------------------------------
 
-1. Fork the `prospector` repo on GitHub.
+1. Fork the `docker-prospector` repo on GitHub.
 2. Clone your fork locally:
 
 ```shell
-    $ git clone [email protected]:your_name_here/prospector.git
+$ git clone [email protected]:your_name_here/prospector.git
 ```
 
 3. [Install docker](https://docs.docker.com/get-started/).
 
 4. Create a branch for local development
 ```shell
-    $ git checkout -b description-of-bug-or-feature
+$ git checkout -b description-of-bug-or-feature
 ````
 
 Now you can make your changes locally.
 
 5. When you're done making changes, check that your changes pass the tests:
 
 ```shell
-    $ pip3 install tox
-    $ tox
+$ pip3 install --user pipenv
+$ pipenv install --dev
+$ pipenv run yamllint .
+$ pipenv run prospector
+$ pipenv run pytest
 ```
 
 6. 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
+$ 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.
@@ -74,4 +77,5 @@ Responsibilities
 ----------------
 
 1. Create issues for any bugs, changes or enhancements.
-2. Be welcoming and nice as outlined in our Code of Conduct (https://www.contributor-covenant.org/version/1/4/code-of-conduct).
+2. Be welcoming and nice as outlined in our
+[Code of Conduct](https://github.com/badpacketsllc/docker-prospector/blob/master/CODE_OF_CONDUCT.md).

Dockerfile

@@ -10,11 +10,11 @@
 #
 # To run `prospector` against code in the current directory using the image
 # from Docker Hub:
-# $ docker run --rm -it  -v $PWD:/data:ro,Z badpacketsllc/prospector prospector
+# $ docker run --rm -it  -v ${PWD}:/data:ro,Z badpacketsllc/prospector
 #
 # To run `prospector` against code in the current directory using the image
 # built locally from source
-# $ docker run --rm -it  -v $PWD:/data:ro,Z prospector
+# $ docker run --rm -it  -v ${PWD}:/data:ro,Z prospector
 #
 # Copyright 2020 Bad Packets LLC
 # Licensed under a GPLv2 license

README.md

@@ -1,8 +1,8 @@
-# prospector
-[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/badpacketsllc/prospector/graphs/commit-activity)
-[![Build status](https://img.shields.io/travis/com/badpacketsllc/prospector.svg?style=flat)](https://travis-ci.com/badpacketsllc/prospector)
-[![Ansible role downloads](https://img.shields.io/docker/pulls/badpacketsllc/prospector)](https://hub.docker.com/r/badpacketsllc/prospector)
-[![License](https://img.shields.io/github/license/badpacketsllc/prospector?style=flat)](https://github.com/badpacketsllc/prospector/blob/master/LICENSE)
+# docker-prospector
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/badpacketsllc/docker-prospector/graphs/commit-activity)
+[![Build status](https://img.shields.io/travis/com/badpacketsllc/docker-prospector.svg?style=flat)](https://travis-ci.com/badpacketsllc/docker-prospector)
+[![Docker image download](https://img.shields.io/docker/pulls/badpacketsllc/prospector)](https://hub.docker.com/r/badpacketsllc/prospector)
+[![License](https://img.shields.io/github/license/badpacketsllc/docker-prospector?style=flat)](https://github.com/badpacketsllc/docker-prospector/blob/master/LICENSE)
 [![Follow us on twitter](https://img.shields.io/twitter/follow/bad_packets.svg?style=social)](https://twitter.com/bad_packets/)
 
 Prospector docker container image
@@ -18,12 +18,12 @@ Usage
 To run `prospector` against code in the current directory using the image
 from Docker Hub:
 
-`$ docker run --rm -it  -v $PWD:/data:ro,Z badpacketsllc/prospector prospector`
+`$ docker run --rm -it  -v ${PWD}:/data:ro,Z badpacketsllc/prospector`
 
 To run `prospector` against code in the current directory using the image
 built locally from source:
 
-`$ docker run --rm -it  -v $PWD:/data:ro,Z prospector`
+`$ docker run --rm -it  -v ${PWD}:/data:ro,Z prospector`
 
 Running tests
 -------------
@@ -48,9 +48,9 @@ Contributing
 ------------
 
 Contributions are encouraged! Learn how to contribute by reading
-[CONTRIBUTING.md](https://github.com/badpacketsllc/prospector/blob/master/CONTRIBUTING.md).
+[CONTRIBUTING.md](https://github.com/badpacketsllc/docker-prospector/blob/master/CONTRIBUTING.md).
 Please be nice and follow our
-[Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct).
+[Code of Conduct](https://github.com/badpacketsllc/docker-prospector/blob/master/CODE_OF_CONDUCT.md).
 
 License
 -------