Skip to content

Commit f0d473e

Browse files
committed
add contributing doc
1 parent a694d3b commit f0d473e

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

CONTRIBUTING.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Contributing
2+
============
3+
4+
Contributions are welcome in the form of bug reports or pull requests.
5+
6+
Bug Reports
7+
-----------
8+
Quality bug reports are welcome at the `DataStax Python Drvier JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_.
9+
10+
There are plenty of `good resources <http://www.drmaciver.com/2013/09/how-to-submit-a-decent-bug-report/>`_ describing how to create
11+
good bug reports. They will not be repeated in detail here, but in general, the bug report include where appropriate:
12+
13+
* relevant software versions (Python runtime, driver version, cython version, server version)
14+
* details for how to produce (e.g. a test script or written procedure)
15+
* any effort to isolate the issue in reproduction is much-appreciated
16+
* stack trace from a crashed runtime
17+
18+
Pull Requests
19+
-------------
20+
If you're able to fix a bug yourself, you can [fork the repository](https://help.github.com/articles/fork-a-repo/) and submit a [Pull Request](https://help.github.com/articles/using-pull-requests/) with the fix.
21+
Please include tests demonstrating the issue and fix. For examples of how to run the tests, consult the `dev README <https://github.com/datastax/python-driver/blob/master/README-dev.rst#running-the-tests>`_.
22+
23+
24+
Contribution License Agreement
25+
------------------------------
26+
To protect the community, all contributors are required to [sign the DataStax Contribution License Agreement](http://cla.datastax.com/). The process is completely electronic and should only take a few minutes.

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ cqlengine (originally developed by Blake Eggleston and Jon Haddad, with contribu
5050
community) is now maintained as an integral part of this package. Refer to
5151
`documentation here <http://datastax.github.io/python-driver/object_mapper.html>`_.
5252

53+
Contributing
54+
------------
55+
See `CONTRIBUTING.md <https://github.com/datastax/ruby-driver/blob/master/CONTRIBUTING.md>`_.
56+
5357
Reporting Problems
5458
------------------
5559
Please report any bugs and make any feature requests on the

0 commit comments

Comments
 (0)