Skip to content

Commit

Permalink
docs(contribution-guidelines): add best practices for Backend and add…
Browse files Browse the repository at this point in the history
…ed the sections Features, API, and Design.
  • Loading branch information
AshwinSri23 authored and MFarabi619 committed Nov 7, 2024
1 parent 4ab88d3 commit 98d24a9
Showing 1 changed file with 23 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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**




Expand Down

0 comments on commit 98d24a9

Please sign in to comment.