Skip to content

Commit

Permalink
Docs: Added GitHub templates and documentation (fixes #15)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewvaughan committed Nov 8, 2017
1 parent b4d7cb9 commit 25fa9dd
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# 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
[via email][email]. 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][homepage], version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct/


[email]: mailto:[email protected]
[homepage]: https://www.contributor-covenant.org
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
If requesting a feature or idea, please delete all of this text and state your
request.
If reporting an issue, please fill out the following:
-->

# Project Details

* **Version:** (enter project version or commit sha)
* **Ansible Version:**
* **Operating System:** (enter operating system type and version)


# What You Expected to Happen


# What Actually Happened


# Steps To Reproduce the Problem (If Any)


# Anything Other Helpful Information
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--
Pull requests must follow this project's contribution guidelines. Please
review these before committing. Pull requests not following these guidelines
will be rejected. The most current set of contribution guidelines can be found
here:
https://github.com/andrewvaughan/ansible-prompt/blob/master/.github/CONTRIBUTING.md
All pull requests must reference an existing issue. Please detail what issue
you are fixing in the commit message (e.g., "Added README (fixes #2)").
-->
14 changes: 14 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# RFID

Support for this module is provided entirely through [GitHub issues][issues]. For more information on filing an
issue, please see the [Contribution Guidelines][contributing] section on [Filing an Issue][contributing-issue].

If you wish to contribute to the project, we recommend reading the [contribution guidelines][contributing] and the
[readme][readme] to learn more about the purpose and standards for the project.


[readme]: https://github.com/andrewvaughan/ansible-prompt/blob/master/README.md
[contributing]: https://github.com/andrewvaughan/ansible-prompt/blob/master/CONTRIBUTING.md
[contributing-issue]: https://github.com/andrewvaughan/ansible-prompt/blob/master/CONTRIBUTING.md#ways-to-contribute

[issues]: https://github.com/andrewvaughan/ansible-prompt/issues

0 comments on commit 25fa9dd

Please sign in to comment.