Submitting an issue on Github - olivierkes/manuskript GitHub Wiki

Bug reports and feature requests for Manuskript are done through Github's infrastructure, so you will need a Github account. Please follow the following steps when submitting issues to keep things nice and orderly.

1. Make sure you are running the latest version of Manuskript. Perhaps your bug or feature was already added!

   If you are comfortable with the technical nitty gritty, you can try running the latest version from source. (Instructions: Linux, Mac OS X, Windows)

2. On Github, find a relevant issue using the search feature to comment on if possible, or open a New Issue instead.

   Explain the nature of your issue in the text area. What happened? What did you expect to happen? How badly does it impact you?

3. If your issue involves a bug or other undesired behaviour, make sure you include a log file.

   In the case the behaviour is reproducible, it is best to take the following steps after having closed Manuskript.

   1. Load Manuskript and go to Help -> Locate Log File...

      This will open a window with a list of log files. The one of the current session should be the newest one.

      Put it aside for now, but keep this window open!

   2. Go through all the steps to reproduce the bug or unwanted behaviour.

   3. Close Manuskript.

   4. You can now attach the log file. To do so, drag the newest log file from the window you opened earlier to the Github issue text area. You should see it become attached.

   Note: Log files contain (technical) information about your device and any Manuskript project(s) loaded. We recommend you reproduce an issue using an empty or test project if you are concerned about leaking any of your work.

4. Make sure you didn't make any mistakes, and submit the issue!

   Keep an eye on your Github notifications. We might have other questions for you!