Skip to content

Commit

Permalink
Add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesls committed Apr 15, 2013
1 parent c4e6320 commit e6b05c1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 12 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.rst
@@ -0,0 +1,17 @@
============
Contributing
============

Contributions are welcome. To ensure that your contributions are accepted
please follow these guidelines.

* Follow pep8
* If you are adding docstrings, follow pep257
* If you are adding new functionality or fixing a bug, please add tests.
* If you are making a large change, consider filing an issue on github
first to see if there are any objections to the proposed changes.

In general, new features or bug fixes **will not be merged unless they
have tests.** This is not only to ensure the correctness of
the code, but to also encourage others to expirement without wondering
whether or not they are breaking existing code.
18 changes: 6 additions & 12 deletions README.rst
Expand Up @@ -149,11 +149,12 @@ pubsub
Contributing
============

Contributions are welcome. Adding support for more
redis commands or fixing bugs is easy:
Contributions are welcome. Please see the `contributing guide`_ for
more details.

* Add unittests for the new command.
* Implement new command.

Running the Tests
=================

To ensure parity with the real redis, there are a set of integration tests
that mirror the unittests. For every unittest that is written, the same
Expand All @@ -162,14 +163,6 @@ instance. In order to run these tests you must have a redis server running
on localhost, port 6379 (the default settings). The integration tests use
db=10 in order to minimize collisions with an existing redis instance.

In general, new features or bug fixes *will not be merged unless they
have tests.* This is not only to ensure the correctness of
the code, but to also encourage others to expirement without wondering
whether or not they are breaking things.


Running the Tests
=================

To run all the tests, install the requirements file::

Expand Down Expand Up @@ -207,3 +200,4 @@ they have all been tagged as 'slow' so you can skip them by running::


.. _redis-py: http://redis-py.readthedocs.org/en/latest/index.html
.. _contributing guide: https://github.com/jamesls/fakeredis/blob/master/CONTRIBUTING.rst

0 comments on commit e6b05c1

Please sign in to comment.