Skip to content

How to report a bug

DC* edited this page Oct 25, 2016 · 1 revision

As per https://github.com/zsh-users/antigen/blob/develop/CONTRIBUTING.md#bug-reports.

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

  3. Isolate the problem — create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information.

Please try to be as detailed as possible in your report. Be sure to include:

  • Antigen, Zsh and OS version
  • Antigen and Zsh configurations (usually ~/.zshrc and ~/.antigenrc)
  • What would you expect to be the outcome?
  • What are the steps to reproduce the issue

All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the Zsh version/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the zsh configuration

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Clone this wiki locally