Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.2 KB

Contributing-Guide.md

File metadata and controls

39 lines (24 loc) · 1.2 KB

How to Contribute, Create Issues, and Submit Pull Requests

Creating Issues:

The first thing you should always do, no matter the objective, is create an issue. Use appropriate labels to indicate the purpose of the issue. For example, use the bug label to indicate you have found an error in the module, or the feature request label to indicate something you want to be added.

Rules for creating issues:

  • Use a clear, descriptive title
  • Tell us what you want and why
  • If you can, please include suggestions on how to accomplish the objective
  • Do not be rude to our collaborators. Everyone that works on this does so on their own free time and owe you nothing
  • Use the appropriate template
  • The better you follow these rules, the more likely we are to work on your issue
## What currently exists:

Description of the current state of the problem.

## What should exist:

Description of your ideal functionality.

## How might this be implemented?:

If you are able, suggest how this might be accomplished

## Why (be specific):

Why is this necessary? Include specific examples and broad use cases.

## Other comments: 

Anything else you want to say.

// TODO: guidelines for creating pull requests