Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.4 KB

Contributing

I welcome and appreciate contributions!

What should I work on?

You can help most by:

  • Logging issues to help improve the project
  • Creating pull requests for existing issues

Before filing an issue

Please check for an existing issue before logging a new one. If you find one that matches, give it a thumbs up and comment any additional info that might help resolve the issue. If there isn't an existing issue, choose the appropriate template and fill out the requested information.

Here are some items to consider while writing the issue:

  • Use a clear and descriptive title
  • Detail what is happening now vs what should happen
  • Describe how to reproduce the issue, including step by step instructions, environment, version, and any other relevant information.
  • Can it be reliably reproduced? If not, mention how often it happens and under what circumstances.
  • Did this problem start after a recent release? If so, which version?

Before submitting a pull request

I am accepting and appreciate pull requests, but please log an issue first if the change isn't trivial. I would hate to turn down your hard work for some reason. Mention your interest in working on the issue when you log it, and I'll provide feedback/guidance.

Make sure the pull request's title adheres to the conventional commits specification.