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.
  10 Thank you for this, and in return we will reciprocate that respect in addressing your issue
  11 or assessing patches with goodwill.
  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 # Using the issue tracker = read before
  23
  24 Before using the issue tracker, we require you read the specific guidelines, depending on the topic:
  25 a bug report, a feature request or a pull request.
  26
  27 ## Bug report
  28
  29 A bug is a _demonstrable problem_ that is caused by the code in the repository.
  30 Good bug reports are extremely helpful - thank you! Good bug reports are also quite rare.
  31 To help and raise the bug report quality, please read the wiki document about [Bug Reports](https://github.com/YOURLS/YOURLS/wiki/Bug-Report)
  32
  33 ## Feature request
  34
  35 Feature requests are welcome. But take a moment to find out whether your idea fits the scope and
  36 goals of the project. Check also the [Roadmap](https://github.com/YOURLS/YOURLS/wiki/Road-Map),
  37 maybe your idea is already planned.
  38
  39 It's up to you to make a strong case to convince the project's developers of the merits of this feature.
  40 Please provide as much detail and context as possible and get in touch. Feel free to detail how you envision
  41 things, be they about (pseudo)code, interface, mockup, etc...
  42
  43 ## Pull request
  44
  45 Good pull requests are a fantastic help. But please get in touch before you start working,
  46 it's always a sad moment to dismiss a patch for which a coder has spent a lot of time because
  47 it simply does not fit the project. Please read the wiki
  48 document about [Pull requests](https://github.com/YOURLS/YOURLS/wiki/Pull-Request)
  49