Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions .github/ISSUE_TEMPLATE/1_Bug_report.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
---
name: "🐛 Bug Report"
about: Report a general bug

---
<!--- Provide a general summary of the issue in the Title above -->

## Expected Behavior
<!--- Tell us what should happen -->

- php-resque Version: v#.#.#
- PHP Version:
- Redis Version:
## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->

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

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

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

## My Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* PHP-Resque version:
* PHP version:
* Redis version:
* Server type and version:
* Operating System and version:
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/2_Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: "🚀 Feature Request"
about: I have a suggestion (and may want to implement it 🙂)!
---
<!--- Provide a general summary of the feature in the Title above -->

## Expected Behavior
<!--- Tell us how it should work -->

## Current Behavior
<!--- Explain the difference from current behavior -->

## Possible Solution
<!--- Not obligatory, but suggest ideas how to implement the addition or change -->

## Context
<!--- How has not having this feature affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/2_Support_question.md

This file was deleted.

16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/3_Support_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: "🧐 Support Question"
about: I need assistance with php-resque
---
<!--- Provide a general summary of your question in the Title above -->

### My question:
<!--- Provide your actual question, here. Be as specific as possible, so we can help you more easily -->

## My Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* PHP-Resque version:
* PHP version:
* Redis version:
* Server type and version:
* Operating System and version:
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/1_Bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "🐛 Bug Fix"
about: Fixes a bug!
---
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->

<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/2_New_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "🚀 New Feature"
about: Adds a new feature, or enhances an existing one!
---
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What feature does it introduce? -->

<!--- If it relates to an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->

<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/3_Breaking_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: "💥 Breaking Change"
about: A change that might BREAK THINGS in existing code!
---
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

<!--- What functionality is changing in a breaking way? -->

<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->

<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/4_Documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: "📑 Documentation Only"
about: A change that only affects the documentation, not the code itself!
---
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

<!--- If it fixes an open issue, please link to the issue here. -->

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have read the **CONTRIBUTING** document.
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/5_Tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: "🧪 Tests Only"
about: A change that only affects the tests, not the code itself!
---
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->

<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] All new and existing tests passed.
76 changes: 76 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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 <danhunsaker+resque@gmail.com>. 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.html>

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Contributing to PHP-Resque

First of all: thank you! We appreciate any help you can give PHP-Resque.

Second: before you participate in PHP-Resque, be sure to read our [Code of
Conduct](CODE-OF-CONDUCT.md). Participation indicates you accept and agree to
abide by the guidelines there.

The main way to contribute to PHP-Resque is to write some code! Here's how:

1. [Fork](https://help.github.com/articles/fork-a-repo) PHP-Resque
2. Clone your fork - `git clone git@github.com/your-username/php-resque`
3. Be sure to start from the `develop` branch! - `git checkout develop`
4. Create a topic branch - `git checkout -b my_branch`
5. Push to your branch - `git push origin my_branch`
6. Create a [Pull Request](http://help.github.com/pull-requests/) from your
branch
7. That's it!

If you're not just doing some sort of refactoring, a CHANGELOG entry is
appropriate. Please include them in pull requests adding features or fixing
bugs.

Oh, and 80 character columns, please!

## Tests

We use PHPUnit for testing. A simple `vendor/bin/phpunit` will run all the
tests. Make sure they pass when you submit a pull request.

Please include tests with your pull request.

## Documentation

Writing docs is really important. Please include docs in your pull requests.

## Bugs & Feature Requests

You can file bugs on the [issues
tracker](https://github.com/resque/php-resque/issues), and tag them with 'bug'.

When filing a bug, please follow these tips to help us help you:

### Fill In - Don't Replace! - The Template

The sections in the issue template are there to ensure we get all the
information we need to reproduce and fix your bug. Follow the prompts in there,
and everything should be great!

### Reproduction

If possible, please provide some sort of executable reproduction of the issue.
Your application has a lot of things in it, and it might be a complex
interaction between components that causes the issue.

To reproduce the issue, please make a simple Job that demonstrates the essence
of the issue. If the basic job doesn't demonstrate the issue, the issue may be
in another package pulled in by Composer.

### Version information

If you can't provide a reproduction, a copy of your `composer.lock` would be
helpful.