Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 2.11 KB

Contributing to MiKTeX

Reporting a bug

Check list

Please review this check list, before you click the Submit button:

  1. you have installed the latest MiKTeX updates
  2. the bug report is self-contained: it does not contain links to questions/reports on external sites (e.g., Stack Exchange Network)
  3. step-by-step reproduction instructions
  4. configuration report (initexmf --report) attached
  5. input files attached
  6. log files attached

How to write a good bug report

Before creating a bug report, please check this list:

  1. check the MiKTeX FAQ
  2. write down a one-liner which summarizes the problem
  3. perform an Internet search with the one-liner as the query

Make sure that others will be able to reproduce the bug by providing:

  1. step-by-step reproduction instructions: describe the exact steps which reproduce the problem in as many details as possible
  2. input files which are necessary to reproduce the bug: aka a minimal working example
  3. your observations: command output, screenshots

Most importantly: include information about your MiKTeX setup:

  1. installation report: let MiKTeX Console create an installation report (on the Diagnose page)
  2. contents of the MiKTeX log directory: MiKTeX Console tells you the location of log directory on the Diagnose page

What happens next

A MiKTeX developer will receive a notification. If the bug is reproducible, it will be a attached to a milestone with an estimated fix date.

Unreproducible bugs usually lead to queries. So be prepared to make available additional information.

Please note: sloppy bug reports will be closed (or deleted) without comment.

Proposing a feature

Check list

Please review this check list, before you click the Submit button:

  1. you have installed the latest MiKTeX updates
  2. the feature request is self-contained: it does not contain links to questions/reports on external sites (e.g., Stack Exchange Network)

Please note: sloppy feature requests will be closed (or deleted) without comment.

Thanks!