Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

50 lines (38 loc) · 2.94 KB
Raw

How to contribute

Heya, Luke here. It's awesome that you want to help contribute to CloudBot! This should be as easy as possible for you but there are a few things to consider when contributing.

The following guidelines for contribution should be followed if you want to submit a pull request. If you have any troubles, just come and ask us for help on our IRC channel.

Basic Overview

  • Read Github documentation and Pull Request documentation
  • Fork the repository
  • Edit the files, add new files
  • Check the files with pep8, fix any reported errors
  • Check that the files work as expected in CloudBot
  • Create a new branch with a descriptive name for your feature (optional)
  • Commit changes, push to your fork on GitHub
  • Create a new pull request, provide a short summary of changes in the title line, with more information in the description field.
  • After submitting the pull request, join the IRC channel (irc.esper.net #cloudbot) and give us a link so we know you submitted it.
  • After discussion, your pull request will be accepted or rejected.

How to prepare

  • You need a GitHub account
  • Submit an issue ticket for your issue if there is no one yet.
    • Try to describe the issue and include steps to reproduce if it's a bug.
  • If you are able and want to fix this, fork the repository on GitHub

Make Changes

  • In your forked repository, create a topic branch for your upcoming patch. (optional)
  • Make sure you stick to the coding style that is used already.
  • Make use of the .editorconfig file.
  • Make commits that make sense and describe them properly.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Check your changes with pep8. You can usually ignore messages about line length, but we like to keep lines shorter then 120 characters if at all possible.

Submit Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Open a pull request to the original repository and choose the python3.4 branch. Advanced users may use hub gem for that.
  • If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But please do not close the issue yourself. Notice: You can turn your previously filed issues into a pull-request here.

Additional Resources