Contributing

   1 Greetings. Firstly, if you're thinking of contributing to
   2 beanstalkd, thank you! It's the hard work of people like you that
   3 keeps beanstalkd a high-quality codebase and running smoothly in
   4 the demanding, high-volume production environment of the servers
   5 of many organizations around the world.
   6
   7 We don't have a lot of rules, but here are some tips to keep in
   8 mind that might make your life easier.
   9
  10 General
  11
  12 This is a mature project, so it rarely takes on new features. We
  13 mostly focus on stability, bug fixing, clarity, and performance,
  14 in that order.
  15
  16 Issues
  17
  18 When reporting a bug, please describe:
  19
  20 - which version of beanstalkd you're using
  21 - steps to reproduce the bug
  22 - the behavior you saw
  23 - the behavior you expected
  24
  25 If you're not using the latest version, please consider also
  26 testing with the latest. There's a good chance the bug you found
  27 has already been fixed.
  28
  29 Pull Requests
  30
  31 When opening a pull request, try to keep the changes focused on
  32 one topic and avoid unrelated changes (even small things, like
  33 editing punctuation or whitespace in comments).
  34
  35 If you're making big changes, consider discussing it on the
  36 mailing list first. You might save yourself a lot of time if it
  37 turns out that the changes you want to make aren't a good fit for
  38 the project. This is especially true if you are adding new
  39 functionality.