CONTRIBUTING.md

Instructions For Logging Issues

1. Search For Duplicates

Search the existing issues before logging a new one.

2. Did You Find A Bug?

When logging a bug, please be sure to include the following:

• What version of the package/plugin are you using
• If at all possible, an isolated way to reproduce the behavior
• The behavior you expect to see, and the actual behavior

3. Do You Have A Suggestion?

We also accept suggestions in the issue tracker. Be sure to search first.

Instructions For Contributing Code

What You'll Need

0. A bug or feature you want to work on! If you have found a new bug or want to propose a feature, please create an issue before starting a pull request.
1. A GitHub account.
2. The latest working copy of the code.

Housekeeping

Your pull request should:

• Include a description of what your change intends to do

• Reference any open issues that the PR addresses

• Be based on reasonably recent commit in the master branch

• Contain proper semantic commit messages as follows:

    <type>[<scope>]: (<issue #>) <short summary>
      │      │           |             │
      |      |           |             └─> Summary in present tense. Not capitalized. No period at the end.
      |      |           |
      │      │           └─> Issue # (optional): Issue number if related to bug database.
      │      │
      │      └─> Scope (optional): eg. common, compiler, authentication, core
      │
      └─> Type: chore, docs, feat, fix, refactor, style, or test.
  

• To avoid line ending issues, set autocrlf = input and whitespace = cr-at-eol in your git configuration