From 418a366a6cdf55b0fcd3b4cedc0a1694a4100e7e Mon Sep 17 00:00:00 2001 From: Mike Nakhimovich Date: Sun, 8 Jan 2017 18:33:04 -0500 Subject: [PATCH] Update and rename contributing.md to CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ contributing.md | 10 ---------- 2 files changed, 38 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 contributing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..46bfe401e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +Contributing to Store +======================= + +The New York Times team welcomes contributions of all kinds, from simple bug reports through documentation, test cases, +bugfixes, and features. + +DOs and DON'Ts +-------------- + +* DO follow our coding style (as described below) +* DO give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. +* DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken. +* DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion. +* DO run all Gradle verification tasks (`./gradlew check`) before submitting a pull request + +* DO NOT send PRs for style changes. +* DON'T surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time. +* DON'T commit code that you didn't write. If you find code that you think is a good fit, file an issue and start a discussion before proceeding. +* DON'T submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it. + + +Coding Style +------------ + +The coding style employed here is fairly conventional Java - indentations are four spaces, class +names are PascalCased, identifiers and methods are camelCased. + +Workflow +-------- + +We love Github issues! Before working on any new features, please open an issue so that we can agree on the +direction, and hopefully avoid investing a lot of time on a feature that might need reworking. + +Small pull requests for things like typos, bugfixes, etc are always welcome. + +Please note that we will not accept pull requests for style changes. + + diff --git a/contributing.md b/contributing.md deleted file mode 100644 index 1b86856b0..000000000 --- a/contributing.md +++ /dev/null @@ -1,10 +0,0 @@ -# Contributing to Store - -If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request targeting the branch `develop` branch. - -When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. - -## License - -By contributing your code, you agree to license your contribution under the terms of the licesnse. -All files are released with the Apache 2.0 license.