Skip to content

Loading…

Revised copy for contributing.md #23

Closed
MartinStellar opened this Issue · 1 comment

2 participants

@MartinStellar

Contribute Your Code to aws-mock – All JVM Languages Welcome!

You may want to add some new features/improvements to aws-mock (or maybe you already did). Additions are extremely welcome and we would immensely appreciate your contribution to aws-mock!
What follows are some helpful instructions that wil make your development process easier.
It will also make your code a better fit for merging it with the aws-mock source tree.

For example, let's say you want to add a mock of Amazon web service such as S3:
To mock S3, you put S3's WSDL to [note: should this not be 'in', instead of 'to'?] cxf-stub (the sub project under aws-mock)
Then write a new 'wsdl2java' task according to cxf-stub/build.gradle
Generate the Java API stub for developing S3 interfaces
Add a new servlet as the mock S3 endpoint, which will parse interface call requests from clients
Write your logic for mocking behind the servlet
Pick and organize the response object by making use of the newly generated S3 cxf-stub
Debug the mock S3 endpoint with your favorite AWS SDK
Add tests for your code
Run gradle check in your fork before you send the pull request to make sure your code passes the basic checks and tests

And that's all there is to it.

Except for the final, juicy bit: You can CONTRIBUTE YOUR CODE IN ANY JVM LANGUAGE YOU LIKE – Groovy, Clojure, JRuby, Jython, Scala, and of course Java if that's your thing.
We're looking forward to your contributions – surprise us!

@christopherbalz
TreeLogic Software Engineering member

This has been integrated. Thanks MartinStellar!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.