CONTRIBUTING.md

   1 # YOURLS
   2 ![alt](http://yourls.org/images/yourls-logo.png)
   3
   4 # Contributing to this project
   5
   6 Please take a moment to review this document, or see your issue / pull request closed with *harsh comments*.
   7
   8 Following these guidelines helps to communicate that you respect the time of
   9 the developers managing and developing for free this open source project during their free time. In return,
  10 they will reciprocate that respect in addressing your issue or assessing
  11 patches and features. Right?
  12
  13 # Using the issue tracker = search before
  14
  15 The issue tracker is the preferred channel for bug reports, features requests and submitting pull
  16 requests, but please respect the following restrictions:
  17
  18 * Please **do not** use the issue tracker for personal support requests. Use sites such as
  19   [Stack Overflow](http://stackoverflow.com) instead.
  20 * Please, please, please, **SEARCH** before you file a new issue or request.
  21
  22
  23 # Bug reports
  24
  25 A bug is a _demonstrable problem_ that is caused by the code in the repository.
  26 Good bug reports are extremely helpful - thank you!
  27
  28 Guidelines for bug reports:
  29
  30 1. **Use the GitHub issue search** &mdash; check if the issue has already been
  31    reported.
  32 2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
  33    latest [master](https://github.com/YOURLS/YOURLS/archive/master.zip)
  34 3. **Isolate the problem** &mdash; create a reduced step-by-step test
  35    case
  36 4. **Give details** that are relevant to the bug: OS used? browser and server software versions?
  37    What is the   expected output? What do you see instead?
  38
  39 A good bug report **must not** leave others needing to chase you up for more
  40 information. Or your issue will be closed with *harsh comments*.
  41
  42 # Feature requests
  43
  44 Feature requests are welcome. But take a moment to find out whether your idea
  45 fits with the scope and aims of the project. It's up to *you* to make a strong
  46 case to convince the project's developers of the merits of this feature. Please
  47 provide as much detail and context as possible and get in touch.
  48
  49 # Pull requests
  50
  51 Good pull requests - patches, improvements, new features - are a fantastic
  52 help. They should remain focused in scope and avoid containing unrelated
  53 commits.
  54
  55 **Please ask first** before embarking on any significant pull request (e.g.
  56 implementing features, refactoring code... ), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
  57
  58 By submitting a patch, you agree to allow the project owner to
  59 license your work under the same license as that used by the project.
  60