Merge pull request #418 from akutz/feature/issues-coc

Adding Issue Template & Code-of-Conduct

.github/code_of_conduct.md

@@ -0,0 +1,94 @@
+# Code of Conduct
+
+## 1. Purpose
+
+A primary goal of libStorage is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in libStorage to help us create safe and positive experiences for everyone.
+
+## 2. Open [Source/Culture/Tech] Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+- Exercise consideration and respect in your speech and actions.
+Attempt collaboration before conflict.
+- Refrain from demeaning, discriminatory, or harassing behavior and speech.
+- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+- Violence, threats of violence or violent language directed against another person.
+- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+- Posting or displaying sexually explicit or violent material.
+- Posting or threatening to post other people’s personally identifying information ("doxing").
+- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+- Inappropriate photography or recording.
+- Inappropriate physical contact. You should have someone’s consent before touching them.
+- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
+- Deliberate intimidation, stalking or following (online or in person).
+- Advocating for, or encouraging, any of the above behavior.
+- Sustained disruption of community events, including talks and presentations.
+
+## 5. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 6. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible by contacting a core team member.
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 7. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the libStorage team with a concise description of your grievance.
+
+## 8. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 9. Contact info
+
+**To report or discuss a suspected violation of this code of conduct by a community member, you may contact any of the team directly and in confidence**:
+
+- Andrew Kutz
+- Clint Kitson
+
+**To report or discuss a suspected violation of this code of conduct by a member of the core team, you may contact any of these people in confidence**:
+
+- Josh Bernstein, VP @ Dell EMC
+  - email: [email protected]
+  - twitter: [@quityourjoshing](http://twitter.com/quityourjoshing)
+
+## 10. License and attribution
+
+This Code of Conduct is distributed under a Creative Commons Attribution-ShareAlike license.
+
+It is derived from the Citizen Code of Conduct at http://citizencodeofconduct.org/.
+
+Portions of text derived from the Django Code of Conduct and the Geek Feminism Anti-Harassment Policy.
+
+Revision 2.1. Posted 4 February 2015.
+
+Revision 2.0, adopted by the Stumptown Syndicate board on 10 January 2013. Posted 17 March 2013.

.github/issue_template.md

@@ -0,0 +1,77 @@
+# Summary
+Please enter a summary of the issue here.
+
+# New Feature
+This section is for issues that relate to suggested enhancements or other
+ideas that may improve libStorage. Please provide as much detail as possible
+regarding the idea. This issue will then serve as the means to have a
+discussion about your idea!
+
+# Bug Reports
+This section is for issues that relate to discovered problems or bugs.
+
+## Expected Behavior
+Please describe in detail the expected behavior.
+
+## Actual Behavior
+Please describe in detail the actual behavior.
+
+## Steps To Reproduce
+Please list the steps to reproduce the issue in this section.
+
+1. The first step should always be enabling `debug` logging.
+  * Open the file `/etc/libstorage/config.yml` (or the config file for the
+application using libStorage)
+  * Set the log level for libStorage to `debug` and enable HTTP request and
+response tracing for libStorage:
+```yaml
+libstorage:
+  logging:
+    level:         debug
+    httpRequests:  true
+    httpResponses: true
+```
+* Please list each step with as much detail as possible.
+* The more information gathered up front, the easier it is to solve
+the problem.
+* Thank you!
+
+## Configuration Files
+Please paste any related configuration files, such as
+`/etc/libstorage/config.yml` (or the config file for the application using
+libStorage in this section. Please use the appropriate formatting when pasting
+YAML content. For example:
+
+```yaml
+libstorage:
+  logging:
+    level:         debug
+    httpRequests:  true
+    httpResponses: true
+  service:         ebs
+ebs:
+  accessKey:       123456
+  secretKey:       abcdef
+```
+
+Proper formatting of pasted content is very important as structured data can
+sometimes be accidentally recorded incorrectly, affecting the desired outcome.
+
+## Logs
+It is very important when filing an issue to include associated logs. There are
+two different logs about which to be concerned: the service log (if libStorage
+is running as a service) and the client log.
+
+### Service Log
+A service that embeds the libStorage service may have its own service log.
+Instead of pasting the entire log file into this issue, please create a new
+[gist](https://gist.github.com/) and paste the log file's contents there.
+Please name the file `libstorage-service.log` in the gist. The proper extension
+will indicate how to format the contents.
+
+### Client Log
+libStorage clients may emit their logs to the console or there may be an
+associated client log file. Please copy the contents of the console and paste
+them into the same gist as above naming the file `libstorage-client.log.sh`.
+The `sh` extension will cause the contents to be formatted as if they were
+emitted to the shell, which they were.