From 98d24a99720a3312d003eab997fbb7acec6c75cf Mon Sep 17 00:00:00 2001 From: AshwinSri23 Date: Sat, 12 Oct 2024 16:24:50 -0400 Subject: [PATCH] docs(contribution-guidelines): add best practices for Backend and added the sections Features, API, and Design. --- .../coding-guidelines.mdx | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/apps/docs/src/content/docs/contribution-guidelines/coding-guidelines.mdx b/apps/docs/src/content/docs/contribution-guidelines/coding-guidelines.mdx index 5145543ae..1e49fbc8d 100644 --- a/apps/docs/src/content/docs/contribution-guidelines/coding-guidelines.mdx +++ b/apps/docs/src/content/docs/contribution-guidelines/coding-guidelines.mdx @@ -141,6 +141,29 @@ All tests can be viewed on the github workflow. When running different tests, make sure you select the right environments for each of these tests. +### **Backend** + +#### Adding issues +When working on an issue, making commits with description when necessary. +- For example, when generating a library(ex: a database library) that will be used, + indicate the command used to generate that library in the commit description. +- Additionally, when working on an issue, begin with defining the requirements to a given issue + before attempting to resolve it. + +Be cautious when modifying tsconfig files. +- Frequent modifications to tsconfig files can lead to a snowball effect when adding features + or modifying existing features. + + +### **Features** +TBD + + +### **API** +TBD + +### **Design** +