CONTRIBUTING.md

   1 # Filing an issue
   2
   3 ### Must read
   4 * If you aren't sure, you can ask on the [**forum**](http://forum.qbittorrent.org) or read our [**wiki**](http://wiki.qbittorrent.org) first.
   5 * Do a quick **search**. Others might already reported the issue.
   6 * Write in **English**!
   7 * Provide **version** information: (You can find version numbers at menu `Help -> About -> Libraries`)
   8   ```
   9   qBittorrent:
  10   Qt:
  11   libtorrent:
  12   boost:
  13   OS version:
  14   ```
  15 * Provide **steps** to reproduce the problem, it will be easier to pinpoint the fault.
  16 * **Screenshots**! A screenshot is worth a thousand words. just upload it. [(How?)](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests)
  17
  18 ### Good to know
  19 * **Be patient**. The dev team is small and resource limited. Devs finding their free time, analyzing the problem and fixing the issue, it all takes time. :clock3:
  20 * If you can code, why not become a **contributor** by fixing the issue and open a pull request? :wink:
  21 * Harsh words or threats won't help your situation. What's worse, your complain will (very likely) to be **ignored**. :fearful:
  22
  23
  24 # Opening a pull request
  25
  26 ### Must read
  27 * Read our [**coding guidelines**](https://github.com/qbittorrent/qBittorrent/blob/master/CODING_GUIDELINES.md). There are some scripts to help you: [uncrustify script](https://raw.githubusercontent.com/qbittorrent/qBittorrent/master/uncrustify.cfg), [astyle script](https://gist.github.com/Chocobo1/539cee860d1eef0acfa6), [(related thread)](https://github.com/qbittorrent/qBittorrent/issues/2192).
  28 * Keep the title **short** and provide a **clear** description about what your pull request does.
  29 * Provide **screenshots** for UI related changes.
  30 * Keep your git commit history **clean** and **precise**. Commits like `xxx fixup` should not appear.
  31 * If your commit fix a reported issue (for example #4134), add the following message to the commit `Closes #4134.`. Example [here](https://github.com/qbittorrent/qBittorrent/commit/a74bac20c4e8de9776bf9bb77fdc7526135d1988).
  32
  33 ### Good to know
  34 * **Search** pull request history! Others might already implemented your idea and is waiting to be merged (or got rejected already). Save your precious time by doing a search first.
  35 * When resolving merge conflicts, do `git rebase <target_branch_name>`, don't do `git pull`. Then you can start fixing the conflicts. Here is a good explanation: [link](https://www.atlassian.com/git/tutorials/merging-vs-rebasing).