Add contributing information

kirsle · kirsle · commit 59c0fd27f40b · 2015-01-05T15:17:30.000-08:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,36 @@
+# Contributing
+
+Interested in contributing to RiveScript? Great!
+
+First, check the general contributing guidelines for RiveScript and its primary
+implementations found at <http://www.rivescript.com/contributing> - in
+particular, understand the goals and scope of the RiveScript language and the
+style guide for the Python implementation.
+
+# Quick Start
+
+Fork, then clone the repo:
+
+```bash
+$ git clone git@github.com:your-username/rivescript-python.git
+```
+
+Make your code changes and test them by using the built-in interactive mode of
+RiveScript, e.g. by running `python rivescript /path/to/brain`.
+
+Make sure the unit tests still pass. I use Nosetests for the unit testing, so
+you'll need to install that (you can install it in a virtualenv if it's easier)
+and run the command `nosetests`.
+
+Use `pyflakes` and clean up any error messages reported in the Python sources.
+
+Push to your fork and [submit a pull request](https://github.com/kirsle/rivescript-python/compare/).
+
+At this point you're waiting on me. I'm usually pretty quick to comment on pull
+requests (within a few days) and I may suggest some changes or improvements
+or alternatives.
+
+Some things that will increase the change that your pull request is accepted:
+
+* Follow the style guide at <http://www.rivescript.com/contributing>
+* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Noah Petherbridge
+Copyright (c) 2015 Noah Petherbridge
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,23 +1,20 @@
-RiveScript-Python
-=================
+# RiveScript-Python
 
-INTRODUCTION
-------------
+## INTRODUCTION
 
 This is a RiveScript interpreter for the Python programming language. RiveScript
 is a scripting language for chatterbots, making it easy to write
 trigger/response pairs for building up a bot's intelligence.
 
 This library is compatible with both Python 2 and Python 3.
 
-USAGE
------
+## USAGE
 
 The `rivescript` module can be executed as a stand-alone Python script, or
 included in other Python code. When executed directly, it launches an
 interactive chat session:
 
-    python -m rivescript ./brain
+    python rivescript ./brain
 
 When used as a library, the synopsis is as follows:
 
@@ -40,8 +37,7 @@ while True:
 The scripts `example.py` and `example3.py` provide simple examples for using
 RiveScript as a library for Python 2 and 3, respectively.
 
-UTF-8 SUPPORT
--------------
+## UTF-8 SUPPORT
 
 Version 1.05 adds experimental support for UTF-8 in RiveScript. It is not
 enabled by default. Enable it by passing a `True` value for the `utf8`
@@ -67,8 +63,7 @@ are converted (if needed) to Python's `unicode` data type. So, while it's
 good practice to make sure you're providing Unicode strings to the bot, the
 library will have you covered if you forget.
 
-JSON MODE
----------
+## JSON MODE
 
 The `rivescript` package, when run stand-alone, supports "JSON Mode", where
 you communicate with the bot using JSON. This is useful for third-party
@@ -107,13 +102,12 @@ The bot's response will be formatted like so:
 The `status` will be `ok` on success, or `error` if there was an error. The
 `reply` is the bot's response (or an error message on error).
 
-LICENSE
--------
+## LICENSE
 
 ```
 The MIT License (MIT)
 
-Copyright (c) 2014 Noah Petherbridge
+Copyright (c) 2015 Noah Petherbridge
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/rivescript/__init__.py b/rivescript/__init__.py
@@ -4,7 +4,7 @@
 
 # The MIT License (MIT)
 #
-# Copyright (c) 2014 Noah Petherbridge
+# Copyright (c) 2015 Noah Petherbridge
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/rivescript/__main__.py b/rivescript/__main__.py
@@ -2,7 +2,7 @@
 
 # The MIT License (MIT)
 #
-# Copyright (c) 2014 Noah Petherbridge
+# Copyright (c) 2015 Noah Petherbridge
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/rivescript/interactive.py b/rivescript/interactive.py
@@ -2,7 +2,7 @@
 
 # The MIT License (MIT)
 #
-# Copyright (c) 2014 Noah Petherbridge
+# Copyright (c) 2015 Noah Petherbridge
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/rivescript/python.py b/rivescript/python.py
@@ -2,7 +2,7 @@
 
 # The MIT License (MIT)
 #
-# Copyright (c) 2014 Noah Petherbridge
+# Copyright (c) 2015 Noah Petherbridge
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/rivescript/rivescript.py b/rivescript/rivescript.py
@@ -2,7 +2,7 @@
 
 # The MIT License (MIT)
 #
-# Copyright (c) 2014 Noah Petherbridge
+# Copyright (c) 2015 Noah Petherbridge
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`# The MIT License (MIT)`
`6`	`6`	`#`
`7`		`-# Copyright (c) 2014 Noah Petherbridge`
	`7`	`+# Copyright (c) 2015 Noah Petherbridge`
`8`	`8`	`#`
`9`	`9`	`# Permission is hereby granted, free of charge, to any person obtaining a copy`
`10`	`10`	`# of this software and associated documentation files (the "Software"), to deal`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`# The MIT License (MIT)`
`4`	`4`	`#`
`5`		`-# Copyright (c) 2014 Noah Petherbridge`
	`5`	`+# Copyright (c) 2015 Noah Petherbridge`
`6`	`6`	`#`
`7`	`7`	`# Permission is hereby granted, free of charge, to any person obtaining a copy`
`8`	`8`	`# of this software and associated documentation files (the "Software"), to deal`