1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
mperham--sidekiq/Contributing.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2013-07-21 18:35:52 -04:00
# Contributing
2013-08-24 23:08:51 -04:00
## Issues
2015-02-05 15:24:52 -05:00
When opening an issue:
2013-07-21 18:35:52 -04:00
2015-02-05 15:24:52 -05:00
* include the full **backtrace** with your error
* include your Sidekiq initializer
* list versions you are using: Ruby, Rails, Sidekiq, OS, etc.
2013-07-21 18:35:52 -04:00
2015-02-05 15:24:52 -05:00
It's always better to include more info rather than less.
2013-07-21 18:35:52 -04:00
2015-02-05 15:24:52 -05:00
## Code
2013-07-21 18:35:52 -04:00
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
vision for the project to be accepted; I would be happy to discuss how
your idea can best fit into Sidekiq.
2014-07-17 16:53:54 -04:00
## Legal
2013-07-21 18:35:52 -04:00
2015-02-05 15:24:52 -05:00
By submitting a Pull Request, you disavow any rights or claims to any changes
submitted to the Sidekiq project and assign the copyright of
2014-07-17 16:53:54 -04:00
those changes to Contributed Systems LLC.
2014-07-19 19:22:50 -04:00
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.
2014-07-17 16:53:54 -04:00
This is a legal way of saying "If you submit a PR to us, that code becomes ours".
2015-02-05 15:24:52 -05:00
99.9% of the time that's what you intend anyways; we hope it doesn't scare you
away from contributing.