Permalink
Browse files

Updated README and added CONTRIBUTING file

  • Loading branch information...
1 parent 6f902b8 commit d5774e2a4e3cc93e72f5b31344fa2460efac2114 @daleharvey daleharvey committed Feb 6, 2013
Showing with 76 additions and 5 deletions.
  1. +66 −0 CONTRIBUTING.md
  2. +10 −5 README.md
View
@@ -0,0 +1,66 @@
+[PouchDB](http://pouchdb.com/) - The Javascript Database that Syncs
+==================================================
+
+Welcome, so you are thinking about contributing to PouchDB? awesome, this is a great place to start.
+
+Guide to Contributions
+--------------------------------------
+
+ * Almost all Pull Requests for features or bug fixes will need tests
+ * Looking for something to work on? look for bugs marked [goodfirstbug](https://github.com/daleharvey/pouchdb/issues?labels=goodfirstbug&page=1&state=open)
+ * We follow [Felix's Node.js Style Guide](http://nodeguide.com/style.html
+ * Almost all Pull Requests for features or bug fixes will need tests (seriously, its really important)
+
+Dependencies
+--------------------------------------
+
+PouchDB needs the following to be able to build and test your build, if you havent installed them then best to do do so now, we will wait.
+
+ * [Node.js](http://nodejs.org/)
+ * [CouchDB](http://couchdb.apache.org/)
+
+Building PouchDB
+--------------------------------------
+
+All dependancies installed? great, now building PouchDB itself is a breeze:
+
+ $ cd pouchdb
+ $ npm install -g grunt
+ $ npm install
+ $ grunt
+
+You will now have various distributions of PouchDB in your `dist` folder, congratulations.
+
+Running PouchDB Tests
+--------------------------------------
+
+The PouchDB test suite expects an instance of CouchDB running on 127.0.0.1:5984 and it will need to be in Admin Party.
+
+### Node Tests
+
+ $ grunt node-qunit
+
+### Browser Tests
+
+ $ server cors-server forever
+ # Now visit http://127.0.0.1:8000/tests/test.html in your browser
+
+Git Essentials
+--------------------------------------
+
+Workflows can vary, but here is a very simple workflow for contributing a bug fix:
+
+ $ git clone git@github.com:myfork/pouchdb.git
+ $ git remote add pouchdb https://github.com/daleharvey/pouchdb.git
+
+ $ git checkout -b 121-issue-keyword master
+ # Write tests + code
+ $ git add src/afile.js
+ $ git commit -m "(#121) A brief description of what I changed"
+ $ git push origin 121-issue-keyword
+
+Questions?
+----------
+
+If you have any questions, please feel free to ask on the
+[PouchDB Mailing List](https://groups.google.com/forum/#!forum/pouchdb) or in #pouchdb on irc.freenode.net.
View
@@ -1,10 +1,15 @@
-# PouchDB (Portable CouchDB JavaScript implementation)
-
-The PouchDB Website is at: http://pouchdb.com/
+[PouchDB](http://pouchdb.com/) - The Javascript Database that Syncs
+==================================================
PouchDB is a JavaScript library that allows you to store and query data for web applications that need to work offline, and sync with an online database when you are online.
[![Build Status](https://secure.travis-ci.org/daleharvey/pouchdb.png?branch=master)](http://travis-ci.org/daleharvey/pouchdb)
- * [Running Tests](https://github.com/daleharvey/pouchdb/wiki/Running-and-Writing-Tests)
- * [Guide to Contributing](https://github.com/daleharvey/pouchdb/wiki/Guide-to-Contribution)
+ * [Getting Started Guides + Documentation](http://pouchdb.com)
+ * [Guide to Contributing](https://github.com/daleharvey/pouchdb/blob/master/CONTRIBUTING.md)
+
+Questions?
+----------
+
+If you have any questions, please feel free to ask on the
+[PouchDB Mailing List](https://groups.google.com/forum/#!forum/pouchdb) or in #pouchdb on irc.freenode.net.

0 comments on commit d5774e2

Please sign in to comment.