Merge pull request #16 from carmark/readme

add CONTRIBUTING.md and modify README.md

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# How to contribute #
+
+We'd love to accept your patches and contributions to this project.  There are
+a just a few small guidelines you need to follow.
+
+## Submitting a patch ##
+
+  1. It's generally best to start by opening a new issue describing the bug or
+     feature you're intending to fix.  Even if you think it's relatively minor,
+     it's helpful to know what people are working on.  Mention in the initial
+     issue that you are planning to work on that bug or feature so that it can
+     be assigned to you.
+
+  1. Follow the normal process of [forking][] the project, and setup a new
+     branch to work in.  It's important that each group of changes be done in
+     separate branches in order to ensure that a pull request only includes the
+     commits related to that bug or feature.
+
+  1. Do your best to have [well-formed commit messages][] for each change.
+     This provides consistency throughout the project, and ensures that commit
+     messages are able to be formatted properly by various git tools.
+
+  1. Finally, push the commits to your fork and submit a [pull request][].
+
+[forking]: https://help.github.com/articles/fork-a-repo
+[well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[pull request]: https://help.github.com/articles/creating-a-pull-request
+
+## Coding Style ##
+
+* Go code must be run through 'go fmt'.
+* Follow http://golang.org/doc/effective_go.html as much as possible.
+    + In particular, http://golang.org/doc/effective_go.html#mixed-caps.  Enums
+      should be be CamelCase, with acronyms capitalized (TCPSourcePort, vs.
+      TcpSourcePort or TCP_SOURCE_PORT).
+* Bonus points for giving enum types a String() field.
+* Any exported types or functions should have commentary
+   (http://golang.org/doc/effective_go.html#commentary)

README.md

@@ -16,26 +16,33 @@ $ make
 
 ## Test
 
-You can test this with [libiscsi](https://github.com/gostor/libiscsi).
+You can test this with [open-iscsi](http://www.open-iscsi.com/) or [libiscsi](https://github.com/gostor/libiscsi).
 
-### build the test tool of libiscsi
+## Roadmap
+* Auth (p3)
+* Login Process (p2)
+* ACL (Access control) (p3)
+* SCSI Task Management (p3)
+* iSCSI Task Management (p3)
+* Dummy LUN0 (orzhang, p1)
+* SCSI Command Queue (p2)
+* More SCSI commands
+	* SPC3/SAM2
+	* Page83(Inquiry) (orzhang, p1)
+	* Page0 (Inquiry) (orzhang, p1)
+	* Define Device UUID
+	* More SCSI flags (carmark, p1)
+	* Read8,16 (carmark, p1)
+	* Verify (carmark, p1)
+	* Support `Target Group` and `Target Port` (p3)
+* Refactor (carmark, p1)
+* Command Line (carmark, p1)
+* More Backstore Plugins(such as `ceph` and `raw device`) (orzhang, p1)
+* Redirect iSCSI Target (orzhang, p2)
+* Homepage (p3)
+* More test cases (p2)
+* Docker image (p3)
 
-```
-$ git clone https://github.com/gostor/libiscsi
-$ cd libiscsi
-$ ./autogen.sh
-$ ./configure
-$ make
-```
+## Contributing
 
-### start the gotgt daemon
-
-```
-$ ./citd
-```
-
-### begin the test
-
-```
-$ ./iscsi-test-cu -v iscsi://127.0.0.1:3260/iqn.test.haha/0
-```
+Want to help build Compose? Check out our [contributing documentation](./CONTRIBUTING.md).