Update documentation for changes

Author: linuxdaemon

CONTRIBUTING.md

@@ -1,50 +1,38 @@
 # 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.
+The following guidelines for contribution should be followed if you want to
+submit a pull request.
 
 ## Basic Overview
-
-* Read [Github documentation](http://help.github.com/) and [Pull Request documentation](http://help.github.com/send-pull-requests/)
-* Fork the repository
-* Edit the files, add new files
-* Check the files with [`pep8`](https://pypi.python.org/pypi/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](https://github.com/signup/free)
-* Submit an [issue ticket](https://github.com/ClouDev/CloudBot/issues) 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`](http://editorconfig.org/) 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`](https://pypi.python.org/pypi/pep8). You can usually ignore messages about line length, but we like to keep lines shorter then 120 characters if at all possible.
+1. Read [Github documentation](http://help.github.com/) and [Pull Request documentation](http://help.github.com/send-pull-requests/)
+2. Fork the repository
+3. Create a new branch with a descriptive name for your feature
+4. Edit the files, add new files
+5. Add tests for your changes or new feature
+6. [Use pre-commit] to check that your changes follow the coding style
+7. Add an entry in the [CHANGELOG]
+8. Commit changes, push to your fork on GitHub
+9. Create a new pull request, provide a short summary of changes in the title line, with more information in the description field.
+
+## Use pre-commit
+This project uses [pre-commit]
+1. [Install pre-commit]
+2. Run `pre-commit install` to add it as a git precommit hook to run checks on each `git commit` in the repository
+3. Run `pre-commit run` before commiting, to check your changes easily
 
 ## 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`](https://github.com/defunkt/hub#git-pull-request) 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](http://issue2pr.herokuapp.com/)._
+1. Push your changes to a topic branch in your fork of the repository.
+2. Open a pull request to the original repository and choose the `gonzobot` branch.
+3. Correct any issues shown by the automated checks
+4. Join the [IRC channel] if you have any questions or concerns, or if you just want to talk with other devs
 
 # Additional Resources
-
 * [General GitHub documentation](http://help.github.com/)
 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
 * [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details
 * [This CONTRIBUTING.md from here](https://github.com/anselmh/CONTRIBUTING.md)
+
+[pre-commit]: https://pre-commit.com/
+[Install pre-commit]: https://pre-commit.com/#install
+[Use pre-commit]: #use-pre-commit
+[CHANGELOG]: CHANGELOG.md
+[IRC channel]: README.md#support

README.md

@@ -8,11 +8,10 @@ CloudBot is a simple, fast, expandable open-source Python IRC Bot!
 
 ## Getting CloudBot
 
-There are currently four different branches of this repository, each with a different level of stability:
- - **gonzobot** *(stable)*: This branch contains everything in the **master** branch plus additional plugins added for Snoonet IRC. This branch is the currently maintained branch which will also contain many fixes for various bugs from the master branch.
- - **gonzobot-dev** *(unstable)*: This branch is based off of the **gonzobot** branch and includes new plugins that are not fully tested.
- - **master** *(stable (old))*: This branch contains stable, tested code. This branch is based directly on the upstream master branch and is not currently maintained.
- - **python3.4** *(unstable (old))*: This is the outdated testing branch from the upstream repo.
+You have a few options for getting the bot, you can:
+* Clone the `gonzobot` branch of this repository, using `git pull` to update
+* Download the [latest source]
+* Download the [latest release]
 
 ## Installing CloudBot
 
@@ -33,28 +32,26 @@ Once you have installed the required dependencies and renamed the config file, y
 python3 -m cloudbot
 ```
 
-Note that you can also run the `cloudbot/__main__.py` file directly, which will work from any directory.
-```
-python3 CloudBot/cloudbot/__main__.py
-```
-Specify the path as /path/to/repository/cloudbot/__main__.py, where `cloudbot` is inside the repository directory.
-
 ## Getting help with CloudBot
 
 ### Documentation
 
-The CloudBot documentation is currently somewhat outdated and may not be correct. If you need any help, please visit our [IRC channel](https://webchat.snoonet.org/#gonzobot-dev) and we will be happy to assist you.
+The CloudBot documentation is currently somewhat outdated and may not be correct. If you need any help, please visit our [IRC channel](#support) and we will be happy to assist you.
 
-To write your own plugins, visit the [Plugins Wiki Page](https://github.com/CloudBotIRC/CloudBot/wiki/Writing-your-first-command-plugin).
+To write your own plugins, visit the [Plugins Wiki Page](https://github.com/TotallyNotRobots/CloudBot/wiki/Writing-your-first-command-plugin).
 
-More at the [Wiki Main Page](https://github.com/CloudBotIRC/CloudBot/wiki).
+More at the [Wiki Main Page](https://github.com/TotallyNotRobots/CloudBot/wiki).
 
 ### Support
 
 The developers reside in [#gonzobot-dev](https://webchat.snoonet.org/#gonzobot-dev) on [Snoonet](https://snoonet.org) and would be glad to help you.
 
 If you think you have found a bug/have a idea/suggestion, please **open a issue** here on Github and contact us on IRC!
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
 ## Changelog
 
 See [CHANGELOG.md](CHANGELOG.md)
@@ -90,3 +87,6 @@ This product includes GeoLite2 data created by MaxMind, available from
 Translations are Powered by [Yandex.Translate](https://translate.yandex.com)
 
 This product uses data from <a href="http://wordnik.com">http://wordnik.com</a> in accordance with the wordnik.com API <a href="http://developer.wordnik.com/#!/terms">terms of service</a>.
+
+[latest source]: https://github.com/TotallyNotRobots/CloudBot/archive/gonzobot.zip
+[latest release]: https://github.com/TotallyNotRobots/CloudBot/releases/latest