Skip to content

Commit 1c7d08b

Browse files
committedDec 3, 2016
github: Add .github templates.
1 parent ee6ae97 commit 1c7d08b

File tree

3 files changed

+137
-0
lines changed

3 files changed

+137
-0
lines changed
 

‎.github/CONTRIBUTING.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing
2+
3+
This project provides additional functionality beyond what is provided by the project that it is based off.
4+
Ensure that any issues/pull requests submitted to this project are only for functionality that was provided by
5+
this project. Any issues/pull requests that are based off of the upstream project should be directed directly to them.
6+
7+
When contributing a pull-request to this repository, please first discuss the change you wish to make via issue
8+
with the owners of this repository before making a change. Ensure that the change is only related to functionality
9+
provided by this project only.
10+
11+
Please note we have a code of conduct, please follow it in all your interactions with the project.
12+
13+
## Submitting Changes
14+
15+
Changes are excepted by submitting a pull request directly to the projects Github page.
16+
When creating the pull request the provided template should be used to ensure all required information is provided.
17+
18+
## Code of Conduct
19+
20+
### Our Pledge
21+
22+
In the interest of fostering an open and welcoming environment, we as
23+
contributors and maintainers pledge to making participation in our project and
24+
our community a harassment-free experience for everyone, regardless of age, body
25+
size, disability, ethnicity, gender identity and expression, level of experience,
26+
nationality, personal appearance, race, religion, or sexual identity and
27+
orientation.
28+
29+
### Our Standards
30+
31+
Examples of behavior that contributes to creating a positive environment
32+
include:
33+
34+
* Using welcoming and inclusive language
35+
* Being respectful of differing viewpoints and experiences
36+
* Gracefully accepting constructive criticism
37+
* Focusing on what is best for the community
38+
* Showing empathy towards other community members
39+
40+
Examples of unacceptable behavior by participants include:
41+
42+
* The use of sexualized language or imagery and unwelcome sexual attention or
43+
advances
44+
* Trolling, insulting/derogatory comments, and personal or political attacks
45+
* Public or private harassment
46+
* Publishing others' private information, such as a physical or electronic
47+
address, without explicit permission
48+
* Other conduct which could reasonably be considered inappropriate in a
49+
professional setting
50+
51+
### Our Responsibilities
52+
53+
Project maintainers are responsible for clarifying the standards of acceptable
54+
behavior and are expected to take appropriate and fair corrective action in
55+
response to any instances of unacceptable behavior.
56+
57+
Project maintainers have the right and responsibility to remove, edit, or
58+
reject comments, commits, code, wiki edits, issues, and other contributions
59+
that are not aligned to this Code of Conduct, or to ban temporarily or
60+
permanently any contributor for other behaviors that they deem inappropriate,
61+
threatening, offensive, or harmful.
62+
63+
### Scope
64+
65+
This Code of Conduct applies both within project spaces and in public spaces
66+
when an individual is representing the project or its community. Examples of
67+
representing a project or community include using an official project e-mail
68+
address, posting via an official social media account, or acting as an appointed
69+
representative at an online or offline event. Representation of a project may be
70+
further defined and clarified by project maintainers.
71+
72+
### Enforcement
73+
74+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
75+
reported by contacting the project team. All
76+
complaints will be reviewed and investigated and will result in a response that
77+
is deemed necessary and appropriate to the circumstances. The project team is
78+
obligated to maintain confidentiality with regard to the reporter of an incident.
79+
Further details of specific enforcement policies may be posted separately.
80+
81+
Project maintainers who do not follow or enforce the Code of Conduct in good
82+
faith may face temporary or permanent repercussions as determined by other
83+
members of the project's leadership.
84+
85+
### Attribution
86+
87+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
88+
available at [http://contributor-covenant.org/version/1/4][version]
89+
90+
[homepage]: http://contributor-covenant.org
91+
[version]: http://contributor-covenant.org/version/1/4/

‎.github/ISSUE_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
## Context
4+
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
5+
6+
## Expected Behavior
7+
<!--- Tell us what should happen -->
8+
9+
## Actual Behavior
10+
<!--- Tell us what happens instead -->
11+
12+
## Steps to Reproduce
13+
<!--- Provide an unambiguous set of steps to reproduce this bug -->
14+
1.
15+
2.
16+
3.
17+
4.
18+
19+
## Your Environment
20+
<!--- Include as many relevant details about the environment you experienced the bug in -->
21+
* Version Used:
22+
* Operating System and Version:
23+
* Compiler and Version(s):
24+
25+
## Possible Fix
26+
<!--- Not obligatory, but suggest a fix or reason for the bug -->

‎.github/PULL_REQUEST_TEMPLATE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--- Provide a general summary of the enhancement in the Title above -->
2+
3+
## Context
4+
<!--- Provide a more detailed introduction to the enhancement itself, and why you consider it to be useful -->
5+
6+
## Current and Suggested Behavior
7+
<!--- Tell us what currently happens and then what this enhancement changes -->
8+
9+
## Steps to Explain Enhancement
10+
<!--- Provide an unambiguous set of steps to reproduce this bug -->
11+
1.
12+
2.
13+
3.
14+
4.
15+
16+
## Your Test Environment
17+
<!--- Include as many relevant details about the environment you tested in -->
18+
* Version Used:
19+
* Operating System and Version(s):
20+
* Compiler and version(s):

0 commit comments

Comments
 (0)
Please sign in to comment.