Skip to content

Instantly share code, notes, and snippets.

@meskarune

meskarune/contributing.rst

Created March 26, 2019 20:02
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save meskarune/1670050657afadf0e5de45d135230856 to your computer and use it in GitHub Desktop.
Save meskarune/1670050657afadf0e5de45d135230856 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
contributing.rst

Contributing to IRC Bot

Thanks for your interest in contributing to IRC Bot. What follows is a set of contribution guidelines to make contributing to this project easier.

Bugs and Feature Requests

Bug reports should contain any relevant information from the bot run with debugging set to true. Also explain what actions you took to cause the error and what you think might be the cause of the bug.

For feature requests, have a look at previously closed issues to make sure there aren't any duplicates, then feel free to make a request. (within reason)

Code Conventions

Modules and Plugins

Names for modules and plugins should be lowercase. Longer names can use underscores between words.

Modules are placed in the src directory and plugins are in src/plugins.

Function and Variable Names

Style Guide

Indentation used is 4 spaces

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment