Skip to content

Commit 47c6f9b

Browse files
danhunsakerdanhunsaker
committed
Merge pull request #16 from resque/enhancement/issue-templates
Enhanced Issue/PR Templates
2 parents 21e667d + 8897862 commit 47c6f9b

File tree

11 files changed

+335
-18
lines changed

11 files changed

+335
-18
lines changed

‎.github/ISSUE_TEMPLATE/1_Bug_report.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
11
---
22
name: "🐛 Bug Report"
33
about: Report a general bug
4-
4+
labels: bug
55
---
6+
<!--- Provide a general summary of the issue in the Title above -->
7+
8+
## Expected Behavior
9+
<!--- Tell us what should happen -->
610

7-
- php-resque Version: v#.#.#
8-
- PHP Version:
9-
- Redis Version:
11+
## Current Behavior
12+
<!--- Tell us what happens instead of the expected behavior -->
1013

11-
### Description:
14+
## Possible Solution
15+
<!--- Not obligatory, but suggest a fix/reason for the bug -->
1216

17+
## Steps to Reproduce
18+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
19+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1320

14-
### Steps To Reproduce:
21+
## Context
22+
<!--- How has this issue affected you? What are you trying to accomplish? -->
23+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
1524

25+
## My Environment
26+
<!--- Include as many relevant details about the environment you experienced the bug in -->
27+
* PHP-Resque version:
28+
* PHP version:
29+
* Redis version:
30+
* Server type and version:
31+
* Operating System and version:

‎.github/ISSUE_TEMPLATE/2_Feature_request.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "🚀 Feature Request"
3+
about: I have a suggestion (and may want to implement it 🙂)!
4+
labels: "feature request"
5+
---
6+
<!--- Provide a general summary of the feature in the Title above -->
7+
8+
## Expected Behavior
9+
<!--- Tell us how it should work -->
10+
11+
## Current Behavior
12+
<!--- Explain the difference from current behavior -->
13+
14+
## Possible Solution
15+
<!--- Not obligatory, but suggest ideas how to implement the addition or change -->
16+
17+
## Context
18+
<!--- How has not having this feature affected you? What are you trying to accomplish? -->
19+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

‎.github/ISSUE_TEMPLATE/2_Support_question.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/3_Support_question.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: "🧐 Support Question"
3+
about: I need assistance with php-resque
4+
labels: question
5+
---
6+
<!--- Provide a general summary of your question in the Title above -->
7+
8+
### My question:
9+
<!--- Provide your actual question, here. Be as specific as possible, so we can help you more easily -->
10+
11+
## My Environment
12+
<!--- Include as many relevant details about the environment you experienced the bug in -->
13+
* PHP-Resque version:
14+
* PHP version:
15+
* Redis version:
16+
* Server type and version:
17+
* Operating System and version:

‎.github/PULL_REQUEST_TEMPLATE/1_Bug_fix.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "🐛 Bug Fix"
3+
about: Fixes a bug!
4+
labels: bug
5+
---
6+
<!--- Provide a general summary of your changes in the Title above -->
7+
8+
## Description
9+
<!--- Describe your changes in detail -->
10+
11+
## Motivation and Context
12+
<!--- Why is this change required? What problem does it solve? -->
13+
14+
<!--- If it fixes an open issue, please link to the issue here. -->
15+
16+
## How Has This Been Tested?
17+
<!--- Please describe in detail how you tested your changes. -->
18+
19+
<!--- Include details of your testing environment, and the tests you ran to -->
20+
<!--- see how your change affects other areas of the code, etc. -->
21+
22+
## Checklist:
23+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
24+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
25+
- [ ] My code follows the code style of this project.
26+
- [ ] My change requires a change to the documentation.
27+
- [ ] I have updated the documentation accordingly.
28+
- [ ] I have read the **CONTRIBUTING** document.
29+
- [ ] I have added tests to cover my changes.
30+
- [ ] All new and existing tests passed.

‎.github/PULL_REQUEST_TEMPLATE/2_New_feature.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "🚀 New Feature"
3+
about: Adds a new feature, or enhances an existing one!
4+
labels: "feature request"
5+
---
6+
<!--- Provide a general summary of your changes in the Title above -->
7+
8+
## Description
9+
<!--- Describe your changes in detail -->
10+
11+
## Motivation and Context
12+
<!--- Why is this change required? What feature does it introduce? -->
13+
14+
<!--- If it relates to an open issue, please link to the issue here. -->
15+
16+
## How Has This Been Tested?
17+
<!--- Please describe in detail how you tested your changes. -->
18+
19+
<!--- Include details of your testing environment, and the tests you ran to -->
20+
<!--- see how your change affects other areas of the code, etc. -->
21+
22+
## Checklist:
23+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
24+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
25+
- [ ] My code follows the code style of this project.
26+
- [ ] My change requires a change to the documentation.
27+
- [ ] I have updated the documentation accordingly.
28+
- [ ] I have read the **CONTRIBUTING** document.
29+
- [ ] I have added tests to cover my changes.
30+
- [ ] All new and existing tests passed.

‎.github/PULL_REQUEST_TEMPLATE/3_Breaking_change.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: "💥 Breaking Change"
3+
about: A change that might BREAK THINGS in existing code!
4+
labels: break
5+
---
6+
<!--- Provide a general summary of your changes in the Title above -->
7+
8+
## Description
9+
<!--- Describe your changes in detail -->
10+
11+
## Motivation and Context
12+
<!--- Why is this change required? What problem does it solve? -->
13+
14+
<!--- What functionality is changing in a breaking way? -->
15+
16+
<!--- If it fixes an open issue, please link to the issue here. -->
17+
18+
## How Has This Been Tested?
19+
<!--- Please describe in detail how you tested your changes. -->
20+
21+
<!--- Include details of your testing environment, and the tests you ran to -->
22+
<!--- see how your change affects other areas of the code, etc. -->
23+
24+
## Checklist:
25+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
26+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
27+
- [ ] My code follows the code style of this project.
28+
- [ ] My change requires a change to the documentation.
29+
- [ ] I have updated the documentation accordingly.
30+
- [ ] I have read the **CONTRIBUTING** document.
31+
- [ ] I have added tests to cover my changes.
32+
- [ ] All new and existing tests passed.

‎.github/PULL_REQUEST_TEMPLATE/4_Documentation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "📑 Documentation Only"
3+
about: A change that only affects the documentation, not the code itself!
4+
labels: docs
5+
---
6+
<!--- Provide a general summary of your changes in the Title above -->
7+
8+
## Description
9+
<!--- Describe your changes in detail -->
10+
11+
## Motivation and Context
12+
<!--- Why is this change required? What problem does it solve? -->
13+
14+
<!--- If it fixes an open issue, please link to the issue here. -->
15+
16+
## Checklist:
17+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
18+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
19+
- [ ] I have read the **CONTRIBUTING** document.

‎.github/PULL_REQUEST_TEMPLATE/5_Tests.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "🧪 Tests Only"
3+
about: A change that only affects the tests, not the code itself!
4+
labels: tests
5+
---
6+
<!--- Provide a general summary of your changes in the Title above -->
7+
8+
## Description
9+
<!--- Describe your changes in detail -->
10+
11+
## Motivation and Context
12+
<!--- Why is this change required? What problem does it solve? -->
13+
14+
<!--- If it fixes an open issue, please link to the issue here. -->
15+
16+
## How Has This Been Tested?
17+
<!--- Please describe in detail how you tested your changes. -->
18+
19+
<!--- Include details of your testing environment, and the tests you ran to -->
20+
<!--- see how your change affects other areas of the code, etc. -->
21+
22+
## Checklist:
23+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
24+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
25+
- [ ] My code follows the code style of this project.
26+
- [ ] I have read the **CONTRIBUTING** document.
27+
- [ ] All new and existing tests passed.

‎CODE-OF-CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <[email protected]>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
<https://www.contributor-covenant.org/faq>

0 commit comments

Comments
 (0)