From b014a8813510738a9c1caa7021a3751ad4793ba0 Mon Sep 17 00:00:00 2001 From: Ryan Ernst Date: Mon, 9 Oct 2017 13:25:23 -0700 Subject: [PATCH] Docs: Add note to contributing docs warning against tool based refactoring This commit adds a warning to deter contributers from creating PRs generated by tools to do large refactors just for the sake of refactoring. --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23ebe45372033..bbb01426fded3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,11 @@ If you have a bugfix or new feature that you would like to contribute to Elastic We enjoy working with contributors to get their code accepted. There are many approaches to fixing a problem and it is important to find the best approach before writing too much code. +Note that it is unlikely the project will merge refactors for the sake of refactoring. These +types of pull requests have a high cost to maintainers in reviewing and testing with little +to no tangible benefit. This especially includes changes generated by tools. For example, +converting all generic interface instances to use the diamond operator. + The process for contributing to any of the [Elastic repositories](https://github.com/elastic/) is similar. Details for individual projects can be found below. ### Fork and clone the repository