Suggest an enhancement
Open and issue
Suggest an edit
This section guides you through submitting an enhancement suggestion for this project, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
Before creating enhancement suggestions, please check the list of enhancements suggestions in the issue tracker 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.
Enhancement suggestions are tracked as GitHub issues. Create an issue on the project's repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. It's always better to get more information. You can include links to files or GitHub projects, copy/pasteable snippets or even print screens or animated GIFS. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- List some other similar projects where this enhancement exists.
- Specify which version of the project you're using.
- Specify the current environment you're using. if this is a useful information.
- Use a clear and descriptive title for the pull request to state the improvement you made to the code or the bug you solved.
- Provide a link to the related issue if the pull request is a follow up of an existing bug report or enhancement suggestion.
- Comment why this pull request represents an enhancement and give a rationale explaining why you did it that way and not another way.
- Use the same coding style than the one used in this project.
- Welcome suggestions from the maintainers to improve your pull request.