Permalink
Browse files

Updated README and CONTRIBUTING to reflect our new process

  • Loading branch information...
1 parent 676bf0f commit 9a99f81db7bbb104f4de48667ba6fb65f6f7bac0 @moonglum moonglum committed Nov 9, 2012
Showing with 20 additions and 9 deletions.
  1. +5 −8 CONTRIBUTING.md
  2. +15 −1 README.md
View
@@ -3,10 +3,11 @@
When you want to write code for the project, please follow these guidelines:
1. Claim the ticket: Tell us that you want to work on a certain ticket, we will assign it to you (We don't want two people to work on the same thing ;) )
-2. Write an Integration Test: Describe what you want to do (our integration tests touch the database)
-3. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
-4. Write Documentation for it.
-5. Check with `rake` that everything is fine and send the Pull Request :)
+2. Fork your feature branch from the `development` branch (not the `master` branch)
+3. Write an acceptance test: Describe what you want to do (our integration tests touch the database)
+4. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
+5. Write documentation for it.
+6. Check with `rake` that everything is fine and send the pull request to the `development` branch :)
## How to get started developing
@@ -38,7 +39,3 @@ Guard is a tool for comfortable development. If you want to use it for developme
* Run a documentation server on `http://localhost:8808`
* Run `bundle` whenever you change the dependencies
* Run the integration and unit tests whenever you change a file in the lib or spec directory
-
-### Continuous Integration
-
-Our tests are run on Travis CI, the build status is displayed above. **Please note** that it only runs the unit tests and not the integration tests, because that would require ArangoDB to be installed on the Travis CI boxes. *Therefore green doesn't neccessarily mean green* (which is unfortunate). Therefore it is important that you run the integration tests on your local machine before sending the pull requests.
View
@@ -6,6 +6,16 @@
Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and will be used in different ArangoDB ODMs.
+All tests run on Travis CI for the following versions of Ruby:
+
+* MRI 1.9.2 and 1.9.3
+* Rubinius 1.9 mode
+* JRuby 1.9 mode
+
+We also run on JRuby and MRI Head. MRI-head is currently not passing, because some dependencies are not compatible.
+
+Please note that the `master` branch is always the stable version released on Ruby Gems (*This is actually a lie, but we are currently converting to this model ;) The next release will implement this*). If you want the most recent version, please refer to the `development` branch.
+
## How to use it
For a detailed description of Ashikawa::Core please refer to the [documentation](http://rdoc.info/github/triAGENS/ashikawa-core/master/frames). An example:
@@ -18,6 +28,10 @@ database["my_collection"].name = "new_name"
database["new_name"].delete
```
+# Issues or Questions
+
+If you find a bug in this gem, please report it on [our tracker](https://github.com/triAGENS/ashikawa-core/issues). If you have a question, just contact us via the [mailing list](https://groups.google.com/forum/?fromgroups#!forum/ashikawa) – we are happy to help you :)
+
# Contributing
-If you want to contribute to the project, see CONTRIBUTING.md for details.
+If you want to contribute to the project, see CONTRIBUTING.md for details. It contains information on our process and how to set up everything.

0 comments on commit 9a99f81

Please sign in to comment.