CONTRIBUTING.txt

   1 MagickD Contributing Guide
   2 ==========================
   3
   4 1. Issues
   5 2. git Workflow
   6
   7
   8 Issues
   9 ------
  10
  11 Currently the bindings are incomplete, however, slow progress is gradually being
  12 made to complete them.  Because of this, bug testing isn't extensive.  If you do
  13 encounter a bug, or just want some binding completed quickly, you can just send
  14 me an email.  You don't have to fill out much, just a short description.
  15 Consider the following a template:
  16
  17          [A paragraph or so about what the issue generally is.]
  18
  19          OS Type (GNU/Linux, OSX, etc.) and version(s):
  20
  21             The operating system(s) and their version(s) that you encounter
  22             this issue on.
  23
  24          magickd version(s):
  25
  26             The magickd version(s) that you encounter the issue with.  You don't
  27             have to test every version, just the version you're currently using
  28             and perhaps the latest (if your not currently using it).
  29
  30          GraphicsMagick version(s):
  31
  32             The GraphicsMagick version(s) that you encounter the issue with.
  33             Again, you don't have to extensively test different versions. Please be
  34                 aware that only version 3 and above are supported.
  35
  36          Steps to reproduce:
  37
  38             Perhaps the most important part, how can I encouter the same issue?
  39             If it's an issue with a particular image, you can send that as
  40             an attachment (so long as I have permission to use it as a public
  41             test case).
  42
  43
  44 Publicly tracked issues are currently available in the "Ticket" submenu on the
  45 OSDN page <https://osdn.net/users/nemophila/pf/magickd/ticket/>
  46
  47
  48 git Workflow
  49 ------------
  50
  51 There are two primary repositories for magickd:
  52
  53 * repo.or.cz:     https://repo.or.cz/magickd.git
  54 * OSDN.net:       https://osdn.net/users/nemophila/pf/magickd/
  55
  56 Along with two mirrors:
  57
  58 * rocketgit.com:  https://rocketgit.com/user/dawning/magickd
  59 * codeberg.org:   https://codeberg.org/supercell/magickd
  60
  61
  62 For now, the preferred way of sending your contributions is via email.  My email
  63 address is located on all those sites, or you can find it in the git log.
  64
  65 Alternatively, if you don't want to send an email, the rocketgit repo supports
  66 "anonymous push", this means you can create your git commits, push to the repo
  67 repo and a merge request is automatically created.  The basic workflow for this
  68 is as follows:
  69
  70       > git clone git://git.rocketgit.com/user/dawning/magickd
  71       > cd magickd
  72       # edit some files
  73       > git add -p
  74       > git commit -m $commit_message
  75       > git push origin master
  76
  77 You should be prompted for a username and password. The username is "guest", and
  78 leave the passwork empty.  Finally, please don't use "$commit_message" for the
  79 commit message, write something that's actually useful.