diff --git a/project-templates/feature_request.md b/project-templates/feature_request.md index de43ecb..678bc0b 100644 --- a/project-templates/feature_request.md +++ b/project-templates/feature_request.md @@ -7,13 +7,13 @@ assignees: '' --- -### Title - -*Example: Create Members GET API* - ### Description -Description of the new feature and the problem it is solving. +Provide description of a new feature. Include: + +- How it should work/what problem it solves +- Any specific requirements or edge cases. +- Mockups or examples, if applicable. *Example: Create Members GET API to retrieve a list of members from the file (database) repository. GET @@ -25,21 +25,20 @@ API* *does not modify data. It will also handle GET API Response Codes:* ### Expected behavior -Description of the expected behavior. +Describe the expected behavior. *Example: When Client use GET to access members resources that are located at the specified URL on -the -server the server will respond with the list of members and all its data.* +the server, the server will respond with the list of members and all its data.* -### Solution +### Possible solution -Describe the solution +Describe possible solution. -*Ex: Use the Controller-Service-Repository pattern from Spring Boot applications. The Controller is -responsible for exposing the GET functionality to the client. The Repository is responsible for -storing and retrieving members data. The Service gets the request from the Controller and use -Repository functions to get data from the database.* +*Example: Use the Controller-Service-Repository pattern from Spring Boot applications. The +Controller is responsible for exposing the GET functionality to the client. The Repository is +responsible for storing and retrieving members data. The Service gets the request from the +Controller and use Repository functions to get data from the database.* -### Screenhoots +### Additional Context -Add screenshots +Include any other context, logs, or screenshots that might help explain your request.