Skip to content

Commit

Permalink
update notes, prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mperham committed Feb 5, 2015
1 parent 89f2163 commit 4d73650
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
5 changes: 3 additions & 2 deletions Changes.md
@@ -1,8 +1,9 @@
HEAD
3.3.2
-----------

- Add Sidekiq::Stats#queues back
- Allows configuration of dead job set size and timeout (#2173, jonhyman)
- Allows configuration of dead job set size and timeout [#2173, jonhyman]
- Refactor scheduler enqueuing so Sidekiq Pro can override it. [#2159]

3.3.1
-----------
Expand Down
23 changes: 10 additions & 13 deletions Contributing.md
@@ -1,19 +1,16 @@
# Contributing

First of all, thank you! I hope you find it worthwhile to help out with Sidekiq.

## Issues

When opening an issue, please include a **backtrace** with your error.
When opening an issue:

## Code
* include the full **backtrace** with your error
* include your Sidekiq initializer
* list versions you are using: Ruby, Rails, Sidekiq, OS, etc.

If you're interested in helping or contributing to Sidekiq, here's
some known areas which need improvement:
It's always better to include more info rather than less.

* The Web UI and sidekiq.org website could always use more polish. If you have an eye for design and an idea for improvement, please open an issue and let us know.
* The [Sidekiq issue tracker](https://github.com/mperham/sidekiq/issues) usually has a few ideas
* Your brilliant idea which I haven't listed!
## Code

It's always best to open an issue before investing a lot of time into a
fix or new functionality. Functionality must meet my design goals and
Expand All @@ -22,14 +19,14 @@ your idea can best fit into Sidekiq.

## Legal

By submitting a Pull Request, you disavow any rights or
claims to any changes submitted to the Sidekiq project and assign the copyright of
By submitting a Pull Request, you disavow any rights or claims to any changes
submitted to the Sidekiq project and assign the copyright of
those changes to Contributed Systems LLC.

If you cannot or do not want to reassign those rights (your employment
contract for your employer may not allow this), you should not submit a PR.
Open an issue and someone else can do the work.

This is a legal way of saying "If you submit a PR to us, that code becomes ours".
99.9% of the time that's what you intend anyways; we hope it doesn't scare you away from contributing!

99.9% of the time that's what you intend anyways; we hope it doesn't scare you
away from contributing.
5 changes: 3 additions & 2 deletions Pro-2.0-Upgrade.md
@@ -1,13 +1,14 @@
# Upgrading to Sidekiq Pro 2.0

Sidekiq Pro 2.0 allows nested batches for more complex job workflows
and provides a Lua-based scheduler for reliability and performance.
and provides a new reliable scheduler which uses Lua to guarantee
atomicity and much higher performance.

It also removes deprecated APIs, changes the batch data format and
how features are activated. Read carefully to ensure your upgrade goes
smoothly.

Sidekiq Pro 2.0 requires Sidekiq 3.3.0 or greater. Redis 2.8 is
Sidekiq Pro 2.0 requires Sidekiq 3.3.2 or greater. Redis 2.8 is
recommended; Redis 2.4 or 2.6 will work but some functionality will not be
available.

Expand Down

0 comments on commit 4d73650

Please sign in to comment.