CONTRIBUTING.md

   1 # Contributing to beanstalkd
   2
   3 Greetings. Firstly, if you're thinking of contributing to
   4 beanstalkd, thank you! It's the hard work of people like you that
   5 keeps beanstalkd a high-quality codebase and running smoothly in
   6 the demanding, high-volume production environment of the servers
   7 of many organizations around the world.
   8
   9 Please note that this project is released with a Contributor
  10 Code of Conduct. By participating in this project you agree
  11 to abide by its terms. See CodeOfConduct.txt for details.
  12
  13 ## General
  14
  15 This is a mature project, so it rarely takes on new features. We
  16 mostly focus on stability, bug fixing, clarity, and performance,
  17 in that order.
  18
  19 ## Issues
  20
  21 When reporting a bug, please describe:
  22
  23 - which version of beanstalkd you're using
  24 - steps to reproduce the bug
  25 - the behavior you saw
  26 - the behavior you expected
  27
  28 If you're not using the latest version, please consider also
  29 testing with the latest. There's a good chance the bug you found
  30 has already been fixed.
  31
  32 ## Good commit messages
  33
  34 Please see how to write good commit messages in the Go contributing guide
  35 [here](https://golang.org/doc/contribute.html#commit_messages).
  36
  37
  38 ## Pull Requests
  39
  40 When opening a pull request, try to keep the changes focused on
  41 one topic and avoid unrelated changes (even small things, like
  42 editing punctuation or whitespace in comments).
  43
  44 If you're making big changes, consider discussing it on the
  45 mailing list first. You might save yourself a lot of time if it
  46 turns out that the changes you want to make aren't a good fit for
  47 the project. This is especially true if you are adding new
  48 functionality.