forked from fnproject/fdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
24 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters