Skip to content

Latest commit

 

History

History
39 lines (33 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

39 lines (33 loc) · 2 KB
Raw

Translating

  • Change into the directory where the mikidown source code is
  • Run pylupdate4 -verbose mikidown.pro
  • Replace all instances of filename="mikidown with filename="../mikidown in the generated locale/*.ts files
  • Open Qt Linguist with those *.ts files.
  • Start translating!
  • Alternatively, you can visit https://www.transifex.com/projects/p/mikidown/resources/ to see what needs to be translated. Any translations there will be pulled back into the github repo.

Bug Reporting

Please provide a backtrace of the relevant errors like in #43. If it's a logic error (as in a variable's set to a wrong value), here's what you can do to help me find the error (if I haven't found it yet):

  • Find all of the relevant files you want to set breakpoints at
  • Type this somewhere in that file, properly indented: from .utils import debugTrace
  • Set some breakpoints by adding debugTrace() in said files. These should be placed just before the relevant variable changes to an unexpected value.
  • Run the program with python ./mikidown.py
  • When you get to the breakpoint, print out the variable values with p ${relevantvariable}

If you don't know how to do this, please describe in detail what you did in the GUI to trigger the error (as in what buttons you pressed, etc.).

Feature Requests

Stick them over in the github issues. It greatly helps if you have a detailed list of steps and any mockups for the wanted changes.

Or if you prefer instant messaging of some sort, you can join the chat at https://gitter.im/ShadowKyogre/mikidown

Coding

Ideally, you should create a pull request so I can see what kinds of changes you are making. Otherwise, you can put the patch in a pastebin so I can pick it up from there. If you pick the pastebin option, please link to a pastebin that has syntax highlighting. Also, here's a detailed list of branches and what they're for:

  • master = The current release
  • develop = Experimental features and fixes are here. Tread with caution, unless you like breaking stuff.