Skip to content

Files

Latest commit

 

History

History
47 lines (37 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 2.02 KB

Contributing to Botkit

The following is a set of guidelines for contributing to Botkit. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Submitting Issues

  • You can create an issue here, but before doing that please read the notes below and include as many details as possible with your report. If you can, please include:
    • The version of Botkit you are using
    • The operating system you are using
    • If applicable, what you were doing when the issue arose and what you expected to happen
  • Other things that will help resolve your issue:
    • Screenshots and animated GIFs
    • Error output that appears in your terminal, dev tools or as an alert
    • Perform a cursory search to see if a similar issue has already been submitted

Submitting Pull Requests

  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the JavaScript coding style with details from .jscsrc and .editorconfig files and use necessary plugins for your text editor.
  • Write documentation in Markdown.
  • Use short, present tense commit messages. See Commit Message Styleguide.

Styleguides

General Code

  • End files with a newline.
  • Place requires in the following order:
    • Built in Node Modules (such as path)
    • Local Modules (using relative paths)
  • Avoid platform-dependent code:
    • Use path.join() to concatenate filenames.
  • Using a plain return when returning explicitly at the end of a function.
    • Not return null, return undefined, null, or undefined

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally