From c480b3c56320873407ea7dc6a6efbafd6fde23fa Mon Sep 17 00:00:00 2001 From: Srikanth Chekuri Date: Thu, 19 May 2022 22:24:59 +0530 Subject: [PATCH] Add section outlining ideal workflow for significant features/changes (#1111) --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60aebdab98..54ff60451b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -143,6 +143,33 @@ curl -sL https://github.com/SigNoz/signoz/raw/main/sample-apps/hotrod/hotrod-del ## General Instructions +**Before making any significant changes, please open an issue**. Each issue +should describe the following: + +* Requirement - what kind of use case are you trying to solve? +* Proposal - what do you suggest to solve the problem or improve the existing + situation? +* Any open questions to address + +Discussing your proposed changes ahead of time will make the contribution +process smooth for everyone. Once the approach is agreed upon, make your changes +and open a pull request(s). Unless your change is small, Please consider submitting different PRs: + +* First PR should include the overall structure of the new component: + * Readme, configuration, interfaces or base classes etc... + * This PR is usually trivial to review, so the size limit does not apply to + it. +* Second PR should include the concrete implementation of the component. If the + size of this PR is larger than the recommended size consider splitting it in + multiple PRs. +* If there are multiple sub-component then ideally each one should be implemented as + a separate pull request. +* Last PR should include changes to any user facing documentation. And should include + end to end tests if applicable. The component must be enabled + only after sufficient testing, and there is enough confidence in the + stability and quality of the component. + + You can always reach out to `ankit@signoz.io` to understand more about the repo and product. We are very responsive over email and [slack](https://signoz.io/slack). - If you find any bugs, please create an issue