Skip to content

Commit

Permalink
Adds contrib info.
Browse files Browse the repository at this point in the history
  • Loading branch information
tteggel committed Sep 22, 2017
1 parent 12623c7 commit f6087d3
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing to the Fn Java FDK

We welcome all contributions!

## How to contribute
* Fork the repo.
* Fix an issue. Or create an issue and fix it.
* Create a pull request. Reference the issue that you are fixing.
* Your branch will be built by our CI system. Make sure that this build passes.
* Be ready to respond to comments and questions from the community.
* Good job! Thanks for being awesome!

## Tips for a swift merge
* Make sure your branch has no conflicts with master. Rebase often.
* Ensure that you have updated any JavaDoc or user/technical docs in `/docs`.
* Don't make breaking changes to the public APIs.
* Write tests - especially for public APIs.
* Make sure that changes to `api` are backwards compatible with `runtime` and vice-versa.

6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,11 @@ someone else to do their work.
If this sounds like you, then have a look at the [Fn Flow
quickstart](docs/FnFlowsUserGuide.md).

# Get help

* Come over and chat to us on the [fnproject Slack](https://join.slack.com/t/fnproject/shared_invite/enQtMjIwNzc5MTE4ODg3LTdlYjE2YzU1MjAxODNhNGUzOGNhMmU2OTNhZmEwOTcxZDQxNGJiZmFiMzNiMTk0NjU2NTIxZGEyNjI0YmY4NTA).
* Raise an issue in [our github](https://github.com/fnproject/fn-java-fdk/).

# Contributing

*TBD*
Please see [CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit f6087d3

Please sign in to comment.