You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to documentation.

Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please check the before-submitting-an-enhancement-suggestion list as you might find out that you don't need to create one.

When you are creating an enhancement suggestion, please include as many details as possible.

Before Submitting An Enhancement Suggestion

  • Perform a cursory search of project issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as Jira issues. Provide the following information:

  • Use a clear and descriptive summary for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links, search keywords which you use in those examples. If you're providing snippets in the issue, use backticks (```) to format the code snippets.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots or screen recordings which help you demonstrate the steps where possible.
  • Explain why this enhancement would be useful to most users.
  • Does this enhancement exist in other docs?
  • Which version of the doc are you browsing? You can get the exact version by looking at the url.
  • What OS & Version are you running?
  • What Browser & Version are you running?
  • What Plugins/Extensions & Version have you installed and enabled in your browser?
  • No labels