diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..8ba764f4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +Contributing +============ +All contributions are welcome to be submitted for review for inclusion, but before they will be accepted, we ask that +you follow these simple guidelines: + + +Legal +----- +Fill out the a Contributor License Agreement and send it to opensource@palantir.com: + +- [Individual Contributor License Agreement](cla/palantir_individual_cla.pdf?raw=true) +- [Corporate Contributor License Agreement](cla/palantir_corporate_cla.pdf?raw=true) + + +Code Style +---------- +When submitting code, please make every effort to follow existing conventions and style in order to keep the code as +readable as possible. We realize that the style used in this project might be different that what is used in your +projects, but in the end it makes it easier to merge changes and maintain in the future. + + +Testing +------- +We kindly ask that all new features and fixes for an issue should include any unit tests. Even if it is small +improvement, adding a unit test will help to ensure no regressions or the issue is not re-introduced. If you need help +with writing a test for your feature, please don't be shy and ask! + + +Documentation +------------- +Up-to-date documentation makes all our lives easier. If you are adding a new feature, enhancing an existing feature, or +fixing an issue, please add or modify the documentation as needed and include it with your pull request. diff --git a/cla/palantir_corporate_cla.pdf b/cla/palantir_corporate_cla.pdf new file mode 100644 index 00000000..0b46c995 Binary files /dev/null and b/cla/palantir_corporate_cla.pdf differ diff --git a/cla/palantir_individual_cla.pdf b/cla/palantir_individual_cla.pdf new file mode 100644 index 00000000..4871bc38 Binary files /dev/null and b/cla/palantir_individual_cla.pdf differ diff --git a/readme.md b/readme.md index 6ee70ddd..72502d4a 100644 --- a/readme.md +++ b/readme.md @@ -249,3 +249,8 @@ Tasks License ------- This plugin is made available under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0). + +Contributing +------------ +Contributions to this project must follow the [contribution guide](CONTRIBUTING.md). +