# Contributing Here are the guidelines we'd like you to follow: - [Issues and Bugs](#issue) - [Feature Requests](#feature) - [Pull Request Submission Guidelines](#submit-pr) - [Commit Message Conventions](#commit) ## Found an Issue or Bug? Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. A minimal reproduce scenario allows us to quickly confirm a bug (or point out config problems) as well as confirm that we are fixing the right problem. We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it. Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced. ## Feature Requests? You can _request_ a new feature by creating an issue on Github. If you would like to _implement_ a new feature, please submit an issue with a proposal for your work `first`, to be sure that particular makes sense for the project. ## Pull Request Submission Guidelines Before you submit your Pull Request (PR) consider the following guidelines: - Search Github for an open or closed PR that relates to your submission. You don't want to duplicate effort. - Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages. - Fill out our `Pull Request Template`. Your pull request will not be considered if it is ignored. ## Commit Conventions Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` ():