Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.54 KB

This plugin is an open source project and we would love you to help us make it better.

Reporting Issues

A well formatted issue is appreciated, and goes a long way in helping us help you.

  • Make sure you have a GitHub account
  • Submit a GitHub issue by:
    • Clearly describing the issue
    • Provide a descriptive summary
    • Explain the expected behavior
    • Explain the actual behavior
    • Provide steps to reproduce the actual behavior
    • Put application stacktrace as text (in a Gist for bonus points)
    • Any relevant stack traces

If you provide code, make sure it is formatted with the triple backticks (```).

At this point, we'd love to tell you how long it will take for us to respond, but we just don't know.

Pull requests

We accept pull requests to plugin for:

  • Fixing bugs
  • Adding new features

Not all features proposed will be added but we are open to having a conversation about a feature you are championing.

Here's a quick guide:

  1. Fork the repo.
  2. Create a new branch and make your changes.
  3. Push to your fork and submit a pull request. For more information, see GitHub's pull request help section.

At this point you're waiting on us.

Expect a conversation regarding your pull request, questions, clarifications, and so on.

How to run project locally

Take a look at the DEVELOPMENT.md