Merge pull request #66 from alexdresko/code-of-conduct

Code of conduct
alexdresko · May 27, 2017 · ecf88aa · ecf88aa
2 parents 0508b61 + 0cf5cbf
commit ecf88aa
Show file tree

Hide file tree

Showing 9 changed files with 2,756 additions and 2 deletions.
diff --git a/docs/source/_static/fonts/FontAwesome.otf b/docs/source/_static/fonts/FontAwesome.otf
diff --git a/docs/source/_static/fonts/fontawesome-webfont.eot b/docs/source/_static/fonts/fontawesome-webfont.eot
diff --git a/docs/source/_static/fonts/fontawesome-webfont.svg b/docs/source/_static/fonts/fontawesome-webfont.svg
diff --git a/docs/source/_static/fonts/fontawesome-webfont.ttf b/docs/source/_static/fonts/fontawesome-webfont.ttf
diff --git a/docs/source/_static/fonts/fontawesome-webfont.woff b/docs/source/_static/fonts/fontawesome-webfont.woff
diff --git a/docs/source/_static/fonts/fontawesome-webfont.woff2 b/docs/source/_static/fonts/fontawesome-webfont.woff2
diff --git a/docs/source/change-log.rst b/docs/source/change-log.rst
@@ -9,12 +9,13 @@ Contributers
 
 * 3/11/2017 10:27:59 AM by AD:   Switched to more of a gitflow (http://nvie.com/posts/a-successful-git-branching-model/) based branching strategy. The biggest reason for the switch is because I'm trying to make better use of the build system -- Basically, I don't want to continuously publish an updated nuget package and VSIX extension for every arbitrary change we make. Having a ``dev`` branch allows us to stage blocks of changes before merging ``dev`` into ``master``. It's the merging of ``dev`` into ``master`` that triggers the nuget & VSIX publishing, so you can see why merging directly into ``master`` often would be problematic. Maybe it's just me, but I think it's annoying with a nuget package or VS extension is being updated multiple times a day. 
 * 3/11/2017 10:28:05 AM by AD:   I closed out the "Good enough to use" milestone (https://github.com/alexdresko/HSPI/milestone/1) (because it is), and started "Definitive" https://github.com/alexdresko/HSPI/milestone/2
+* 5/24/2017 1:44:31 PM by AD:   Created a code of conduct in the documentation. 
 
 Templates
 ^^^^^^^^^
 
 * 3/11/2017 7:35:13 PM by AD: The original HomeSeer provided VB.NET templates are included in the VS extension! For the most part, they are completely unmodified. I simply included them in the extension as a reference. For most cases, you'll want to start with the custom C# HSPI project templates that come with the extension. 
-* 3/11/2017 7:37:30 PM by AD:   The binary files created by the templates automatically conform to the standard HS plugin structure wherein the plugin's dependencies are in a subdirectory called ``bin/<plugin name>``. If that sounds confusing, here's what it looks like:
+* 3/11/2017 7:37:30 PM by AD:   The binary files created by the templates automatically conform to the standard HS plugin structure wherein the plugin's dependencies are in a subdirectory called ``bin/<plugin name>``. If that sounds confusing, here's what it looks like::
 
     HSPI_YourPlugIn.exe
     HSPI_YourPlugIn.exe.config
@@ -26,6 +27,8 @@ Templates
     bin\YourPlugIn\Hspi.dll.config
     bin\YourPlugIn\Hspi.pdb
     bin\YourPlugIn\Scheduler.dll
+    bin\YourPlugIn\SomeOtherAssembly.dll
+    bin\YourPlugIn\YetAnotherAssembly.dll
 
  This directory structure enables plugins to avoid version conflicts with other plugins that depend on different versions of the same dependencies. Installing your plugin into HomeSeer is as simple as copying the entire output directory (``/bin/(debug|release)``) into your HomeSeer directory (typically ``C:\Program Files (x86)\HomeSeer HS3``). 
 

diff --git a/docs/source/code-of-conduct.rst b/docs/source/code-of-conduct.rst
@@ -0,0 +1,79 @@
+====================================
+Contributor Covenant Code of Conduct
+====================================
+
+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, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to creating a positive environment
+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
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/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
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+Our 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.
+
+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.
+
+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.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. 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.
+
+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.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the `Contributor Covenant`_, version 1.4,
+available at http://contributor-covenant.org/version/1/4
+
+.. _`Contributor Covenant`: http://contributor-covenant.org
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -32,14 +32,15 @@ Other Helpful Links
 
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 4
     :caption: Contents:
 
     self
     what-is-it
     getting-started
     features
     how-to-contribute
+    code-of-conduct
     change-log
     meta