Skip to main content

Company guides lines for developing the project in real time

 ðŸ‘‰ Real-time project guides lines in my company

Code review comments.

1. Branch name should be aligned to the feature you are developing. Name the branch something like - "Agastya-service"


2. This repository will have just one microservice. You don't need a directory named "SpringBootCurdOperationWithMongoDB".


3. Similarly, the repo name should be Agastya-service

--> your repository name should not have tech stack mentioned, it has to be Agastya-service.


4. DB Url, you have hardcoded in the application.yml. It should be in your local profile. Have profiles created for the application, define it locally, dev, prod. And along with that, create the application-local.YAML, application-dev.yml, application-prod.yml accordingly.


5. In the application.yml define the profile and enable to pick up the profile during the run time. Your run config should have the variable defined for the profile


6. Modal class, instead of student class - create a class "TelemetryEvent" with the following variables.

a. deviceId - PK,String

b. timestamp - timestamp

c. telemetryKey - String

d. telemetryValue - String


7. Never commit any code with commented code. Unless the comment has anything to say to the readers, you shouldn't commit the code with comments.


8. @RequestController - define all the parameters, including the name, value. The base path should be "Agastya" .


9. For each RequestMapping, define the method type and the path. You should be returning a list of telemetry messages, request mapping path should be "telemetry", method = HTTP.GET return type of the method should be <List<TelemetryEvents>> even for a single object. In the parameters, have a parameter to fetch by ID.


10. Don't use setters and getters. Use Lombok library and import them for setters, getters, constructors, parameterized constructors, etc. No boilerplate code at all.


11. Test cases don't do anything. It just starts the application. Have a test class in this case,

a. Create a student, capture the student id. Assert for the student details.

b. find all the students. and filter the student id created. Assert for the ID created and the id in list.

. c. Update the student ID, Assert for the Student ID, and the updates made.


12. Naming conventions have to correct. Do not prefer to start with "_", although it is a convention. Keep close to the objects that you are working on.


13. Graddle config :

. -> group should be "com.technoidentity.agastya"

. -> artifactory = "agastya-service"


14. rootProject.name = 'agastya-service' in settings.gradle


15. README should be in the same folder as that of the project. And the project resources should be the repository.


Comments

Post a Comment

Popular posts from this blog

Generate Documentation for Spring Boot API with swagger and Open API 3

 ðŸ˜‚ How to Generate Documentation for Spring Boot API project Make sure your Project having a swagger or open API 3 Dependency then only you get proper Documentation for your Service. ---------------------------------------------------------------------------- Every method or API above you have to Write Like that then only you get proper Documentation If you do everything in your Application and Run your Application and go to browse and search. . http://localhost:8080/v3/api-docs/ if you want to learn more go with this one.  Open API-3   1. For Return List of Object then you have to use this API operation  @Operation(summary = "This will fetch List of Patient Detailas base on Hospital Name") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Successfully fetch All Patient Details from Database ", content = {  @Content(mediaType = "application/json" ,array = @ArraySchema(schema =@Schema(implementation =PatientDe...
Post a Comment
Read more

#FibonacciNumberSeries Write a program of Fibonacci Number Series|| Fib...

Fibonacci Number Series ============================================ 0 1 1 2 3 5 8 13............. a=0; b=1; i=2; printf(a,b); while(i<=n){ c=a+b; printf(c); a=b; b=c; i++; } =========================================================================== import java.util.Scanner; class Fibonacci { public static void main(String[] args) { Scanner sc=new Scanner(System.in); int n=sc.nextInt(); int a=0,b=1,c; System.out.print(a+" "+b); for(int i=2;i
Post a Comment
Read more

In a new programming language how can store multiple types of data in a single variable OR is it possible how can store multiple types of data in a single variable in programming langauge

In a new programming language how can store multiple types of data in a single variable  OR is it possible how can store multiple types of data in a single variable in a programming language Here In a new programming language how can store multiple types of  data in a single variable   help you make the new  concepts, you are learning a programming  Languages really very important: Ideally Yes. If you create an Array of objects. Then it's possible to store any data type with it as an object is the base class. ArrayList can hold multiple types of data, but array doesn't. Variables Variables can be thought of as ‘containers’ for data. Each variable has to  have a unique name, so that you can refer back to it in the program. By using variables, we can refer to values that have not yet been defined.  For example, we can refer to the speed of the ball in different parts of the  game code, but calculate the ball speed later based on different input...
Post a Comment
Read more